moderation_api 1.2.2 → 2.0.1

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 (438) hide show
  1. checksums.yaml +4 -4
  2. data/.ignore +2 -0
  3. data/CHANGELOG.md +36 -0
  4. data/README.md +198 -62
  5. data/SECURITY.md +27 -0
  6. data/lib/moderation_api/client.rb +98 -0
  7. data/lib/moderation_api/errors.rb +228 -0
  8. data/lib/moderation_api/file_part.rb +58 -0
  9. data/lib/moderation_api/internal/transport/base_client.rb +577 -0
  10. data/lib/moderation_api/internal/transport/pooled_net_requester.rb +208 -0
  11. data/lib/moderation_api/internal/type/array_of.rb +168 -0
  12. data/lib/moderation_api/internal/type/base_model.rb +534 -0
  13. data/lib/moderation_api/internal/type/base_page.rb +55 -0
  14. data/lib/moderation_api/internal/type/boolean.rb +77 -0
  15. data/lib/moderation_api/internal/type/converter.rb +327 -0
  16. data/lib/moderation_api/internal/type/enum.rb +131 -0
  17. data/lib/moderation_api/internal/type/file_input.rb +111 -0
  18. data/lib/moderation_api/internal/type/hash_of.rb +188 -0
  19. data/lib/moderation_api/internal/type/request_parameters.rb +42 -0
  20. data/lib/moderation_api/internal/type/union.rb +243 -0
  21. data/lib/moderation_api/internal/type/unknown.rb +81 -0
  22. data/lib/moderation_api/internal/util.rb +915 -0
  23. data/lib/moderation_api/internal.rb +20 -0
  24. data/lib/moderation_api/models/account_list_params.rb +14 -0
  25. data/lib/moderation_api/models/account_list_response.rb +68 -0
  26. data/lib/moderation_api/models/action_create_params.rb +217 -0
  27. data/lib/moderation_api/models/action_create_response.rb +188 -0
  28. data/lib/moderation_api/models/action_delete_params.rb +14 -0
  29. data/lib/moderation_api/models/action_delete_response.rb +25 -0
  30. data/lib/moderation_api/models/action_list_params.rb +20 -0
  31. data/lib/moderation_api/models/action_list_response.rb +247 -0
  32. data/lib/moderation_api/models/action_retrieve_params.rb +14 -0
  33. data/lib/moderation_api/models/action_retrieve_response.rb +244 -0
  34. data/lib/moderation_api/models/action_update_params.rb +217 -0
  35. data/lib/moderation_api/models/action_update_response.rb +188 -0
  36. data/lib/moderation_api/models/actions/execute_execute_by_id_params.rb +48 -0
  37. data/lib/moderation_api/models/actions/execute_execute_by_id_response.rb +35 -0
  38. data/lib/moderation_api/models/actions/execute_execute_params.rb +64 -0
  39. data/lib/moderation_api/models/actions/execute_execute_response.rb +21 -0
  40. data/lib/moderation_api/models/auth_create_params.rb +14 -0
  41. data/lib/moderation_api/models/auth_create_response.rb +33 -0
  42. data/lib/moderation_api/models/auth_retrieve_params.rb +14 -0
  43. data/lib/moderation_api/models/auth_retrieve_response.rb +25 -0
  44. data/lib/moderation_api/models/author_create_params.rb +127 -0
  45. data/lib/moderation_api/models/author_create_response.rb +272 -0
  46. data/lib/moderation_api/models/author_delete_params.rb +14 -0
  47. data/lib/moderation_api/models/author_delete_response.rb +16 -0
  48. data/lib/moderation_api/models/author_list_params.rb +93 -0
  49. data/lib/moderation_api/models/author_list_response.rb +326 -0
  50. data/lib/moderation_api/models/author_retrieve_params.rb +14 -0
  51. data/lib/moderation_api/models/author_retrieve_response.rb +274 -0
  52. data/lib/moderation_api/models/author_update_params.rb +119 -0
  53. data/lib/moderation_api/models/author_update_response.rb +272 -0
  54. data/lib/moderation_api/models/content_submit_params.rb +871 -0
  55. data/lib/moderation_api/models/content_submit_response.rb +742 -0
  56. data/lib/moderation_api/models/queue/item_list_params.rb +118 -0
  57. data/lib/moderation_api/models/queue/item_list_response.rb +235 -0
  58. data/lib/moderation_api/models/queue/item_resolve_params.rb +32 -0
  59. data/lib/moderation_api/models/queue/item_resolve_response.rb +34 -0
  60. data/lib/moderation_api/models/queue/item_unresolve_params.rb +32 -0
  61. data/lib/moderation_api/models/queue/item_unresolve_response.rb +34 -0
  62. data/lib/moderation_api/models/queue_get_stats_params.rb +22 -0
  63. data/lib/moderation_api/models/queue_get_stats_response.rb +251 -0
  64. data/lib/moderation_api/models/queue_retrieve_params.rb +14 -0
  65. data/lib/moderation_api/models/queue_retrieve_response.rb +190 -0
  66. data/lib/moderation_api/models/wordlist/word_add_params.rb +24 -0
  67. data/lib/moderation_api/models/wordlist/word_add_response.rb +35 -0
  68. data/lib/moderation_api/models/wordlist/word_remove_params.rb +24 -0
  69. data/lib/moderation_api/models/wordlist/word_remove_response.rb +35 -0
  70. data/lib/moderation_api/models/wordlist_get_embedding_status_params.rb +14 -0
  71. data/lib/moderation_api/models/wordlist_get_embedding_status_response.rb +35 -0
  72. data/lib/moderation_api/models/wordlist_list_params.rb +14 -0
  73. data/lib/moderation_api/models/wordlist_list_response.rb +52 -0
  74. data/lib/moderation_api/models/wordlist_retrieve_params.rb +14 -0
  75. data/lib/moderation_api/models/wordlist_retrieve_response.rb +65 -0
  76. data/lib/moderation_api/models/wordlist_update_params.rb +58 -0
  77. data/lib/moderation_api/models/wordlist_update_response.rb +65 -0
  78. data/lib/moderation_api/models.rb +90 -0
  79. data/lib/moderation_api/request_options.rb +78 -0
  80. data/lib/moderation_api/resources/account.rb +32 -0
  81. data/lib/moderation_api/resources/actions/execute.rb +80 -0
  82. data/lib/moderation_api/resources/actions.rb +175 -0
  83. data/lib/moderation_api/resources/auth.rb +50 -0
  84. data/lib/moderation_api/resources/authors.rb +179 -0
  85. data/lib/moderation_api/resources/content.rb +53 -0
  86. data/lib/moderation_api/resources/queue/items.rb +131 -0
  87. data/lib/moderation_api/resources/queue.rb +63 -0
  88. data/lib/moderation_api/resources/wordlist/words.rb +64 -0
  89. data/lib/moderation_api/resources/wordlist.rb +111 -0
  90. data/lib/moderation_api/version.rb +3 -13
  91. data/lib/moderation_api.rb +115 -89
  92. data/manifest.yaml +17 -0
  93. data/rbi/moderation_api/client.rbi +67 -0
  94. data/rbi/moderation_api/errors.rbi +205 -0
  95. data/rbi/moderation_api/file_part.rbi +37 -0
  96. data/rbi/moderation_api/internal/transport/base_client.rbi +305 -0
  97. data/rbi/moderation_api/internal/transport/pooled_net_requester.rbi +84 -0
  98. data/rbi/moderation_api/internal/type/array_of.rbi +104 -0
  99. data/rbi/moderation_api/internal/type/base_model.rbi +314 -0
  100. data/rbi/moderation_api/internal/type/base_page.rbi +43 -0
  101. data/rbi/moderation_api/internal/type/boolean.rbi +58 -0
  102. data/rbi/moderation_api/internal/type/converter.rbi +225 -0
  103. data/rbi/moderation_api/internal/type/enum.rbi +82 -0
  104. data/rbi/moderation_api/internal/type/file_input.rbi +59 -0
  105. data/rbi/moderation_api/internal/type/hash_of.rbi +104 -0
  106. data/rbi/moderation_api/internal/type/request_parameters.rbi +31 -0
  107. data/rbi/moderation_api/internal/type/union.rbi +128 -0
  108. data/rbi/moderation_api/internal/type/unknown.rbi +58 -0
  109. data/rbi/moderation_api/internal/util.rbi +487 -0
  110. data/rbi/moderation_api/internal.rbi +18 -0
  111. data/rbi/moderation_api/models/account_list_params.rbi +32 -0
  112. data/rbi/moderation_api/models/account_list_response.rbi +115 -0
  113. data/rbi/moderation_api/models/action_create_params.rbi +433 -0
  114. data/rbi/moderation_api/models/action_create_response.rbi +354 -0
  115. data/rbi/moderation_api/models/action_delete_params.rbi +32 -0
  116. data/rbi/moderation_api/models/action_delete_response.rbi +36 -0
  117. data/rbi/moderation_api/models/action_list_params.rbi +41 -0
  118. data/rbi/moderation_api/models/action_list_response.rbi +450 -0
  119. data/rbi/moderation_api/models/action_retrieve_params.rbi +32 -0
  120. data/rbi/moderation_api/models/action_retrieve_response.rbi +442 -0
  121. data/rbi/moderation_api/models/action_update_params.rbi +436 -0
  122. data/rbi/moderation_api/models/action_update_response.rbi +354 -0
  123. data/rbi/moderation_api/models/actions/execute_execute_by_id_params.rbi +84 -0
  124. data/rbi/moderation_api/models/actions/execute_execute_by_id_response.rbi +54 -0
  125. data/rbi/moderation_api/models/actions/execute_execute_params.rbi +103 -0
  126. data/rbi/moderation_api/models/actions/execute_execute_response.rbi +33 -0
  127. data/rbi/moderation_api/models/auth_create_params.rbi +32 -0
  128. data/rbi/moderation_api/models/auth_create_response.rbi +48 -0
  129. data/rbi/moderation_api/models/auth_retrieve_params.rbi +32 -0
  130. data/rbi/moderation_api/models/auth_retrieve_response.rbi +36 -0
  131. data/rbi/moderation_api/models/author_create_params.rbi +184 -0
  132. data/rbi/moderation_api/models/author_create_response.rbi +467 -0
  133. data/rbi/moderation_api/models/author_delete_params.rbi +32 -0
  134. data/rbi/moderation_api/models/author_delete_response.rbi +26 -0
  135. data/rbi/moderation_api/models/author_list_params.rbi +213 -0
  136. data/rbi/moderation_api/models/author_list_response.rbi +593 -0
  137. data/rbi/moderation_api/models/author_retrieve_params.rbi +32 -0
  138. data/rbi/moderation_api/models/author_retrieve_response.rbi +472 -0
  139. data/rbi/moderation_api/models/author_update_params.rbi +176 -0
  140. data/rbi/moderation_api/models/author_update_response.rbi +467 -0
  141. data/rbi/moderation_api/models/content_submit_params.rbi +1641 -0
  142. data/rbi/moderation_api/models/content_submit_response.rbi +1456 -0
  143. data/rbi/moderation_api/models/queue/item_list_params.rbi +237 -0
  144. data/rbi/moderation_api/models/queue/item_list_response.rbi +440 -0
  145. data/rbi/moderation_api/models/queue/item_resolve_params.rbi +59 -0
  146. data/rbi/moderation_api/models/queue/item_resolve_response.rbi +55 -0
  147. data/rbi/moderation_api/models/queue/item_unresolve_params.rbi +59 -0
  148. data/rbi/moderation_api/models/queue/item_unresolve_response.rbi +52 -0
  149. data/rbi/moderation_api/models/queue_get_stats_params.rbi +49 -0
  150. data/rbi/moderation_api/models/queue_get_stats_response.rbi +466 -0
  151. data/rbi/moderation_api/models/queue_retrieve_params.rbi +32 -0
  152. data/rbi/moderation_api/models/queue_retrieve_response.rbi +411 -0
  153. data/rbi/moderation_api/models/wordlist/word_add_params.rbi +48 -0
  154. data/rbi/moderation_api/models/wordlist/word_add_response.rbi +58 -0
  155. data/rbi/moderation_api/models/wordlist/word_remove_params.rbi +48 -0
  156. data/rbi/moderation_api/models/wordlist/word_remove_response.rbi +58 -0
  157. data/rbi/moderation_api/models/wordlist_get_embedding_status_params.rbi +32 -0
  158. data/rbi/moderation_api/models/wordlist_get_embedding_status_response.rbi +53 -0
  159. data/rbi/moderation_api/models/wordlist_list_params.rbi +32 -0
  160. data/rbi/moderation_api/models/wordlist_list_response.rbi +80 -0
  161. data/rbi/moderation_api/models/wordlist_retrieve_params.rbi +32 -0
  162. data/rbi/moderation_api/models/wordlist_retrieve_response.rbi +88 -0
  163. data/rbi/moderation_api/models/wordlist_update_params.rbi +95 -0
  164. data/rbi/moderation_api/models/wordlist_update_response.rbi +88 -0
  165. data/rbi/moderation_api/models.rbi +50 -0
  166. data/rbi/moderation_api/request_options.rbi +59 -0
  167. data/rbi/moderation_api/resources/account.rbi +21 -0
  168. data/rbi/moderation_api/resources/actions/execute.rbi +69 -0
  169. data/rbi/moderation_api/resources/actions.rbi +164 -0
  170. data/rbi/moderation_api/resources/auth.rbi +28 -0
  171. data/rbi/moderation_api/resources/authors.rbi +143 -0
  172. data/rbi/moderation_api/resources/content.rbi +84 -0
  173. data/rbi/moderation_api/resources/queue/items.rbi +95 -0
  174. data/rbi/moderation_api/resources/queue.rbi +47 -0
  175. data/rbi/moderation_api/resources/wordlist/words.rbi +48 -0
  176. data/rbi/moderation_api/resources/wordlist.rbi +82 -0
  177. data/rbi/moderation_api/version.rbi +5 -0
  178. data/sig/moderation_api/client.rbs +38 -0
  179. data/sig/moderation_api/errors.rbs +117 -0
  180. data/sig/moderation_api/file_part.rbs +21 -0
  181. data/sig/moderation_api/internal/transport/base_client.rbs +133 -0
  182. data/sig/moderation_api/internal/transport/pooled_net_requester.rbs +48 -0
  183. data/sig/moderation_api/internal/type/array_of.rbs +48 -0
  184. data/sig/moderation_api/internal/type/base_model.rbs +104 -0
  185. data/sig/moderation_api/internal/type/base_page.rbs +24 -0
  186. data/sig/moderation_api/internal/type/boolean.rbs +26 -0
  187. data/sig/moderation_api/internal/type/converter.rbs +79 -0
  188. data/sig/moderation_api/internal/type/enum.rbs +32 -0
  189. data/sig/moderation_api/internal/type/file_input.rbs +25 -0
  190. data/sig/moderation_api/internal/type/hash_of.rbs +48 -0
  191. data/sig/moderation_api/internal/type/request_parameters.rbs +19 -0
  192. data/sig/moderation_api/internal/type/union.rbs +52 -0
  193. data/sig/moderation_api/internal/type/unknown.rbs +26 -0
  194. data/sig/moderation_api/internal/util.rbs +185 -0
  195. data/sig/moderation_api/internal.rbs +10 -0
  196. data/sig/moderation_api/models/account_list_params.rbs +15 -0
  197. data/sig/moderation_api/models/account_list_response.rbs +56 -0
  198. data/sig/moderation_api/models/action_create_params.rbs +195 -0
  199. data/sig/moderation_api/models/action_create_response.rbs +143 -0
  200. data/sig/moderation_api/models/action_delete_params.rbs +15 -0
  201. data/sig/moderation_api/models/action_delete_response.rbs +15 -0
  202. data/sig/moderation_api/models/action_list_params.rbs +25 -0
  203. data/sig/moderation_api/models/action_list_response.rbs +190 -0
  204. data/sig/moderation_api/models/action_retrieve_params.rbs +15 -0
  205. data/sig/moderation_api/models/action_retrieve_response.rbs +185 -0
  206. data/sig/moderation_api/models/action_update_params.rbs +197 -0
  207. data/sig/moderation_api/models/action_update_response.rbs +143 -0
  208. data/sig/moderation_api/models/actions/execute_execute_by_id_params.rbs +51 -0
  209. data/sig/moderation_api/models/actions/execute_execute_by_id_response.rbs +28 -0
  210. data/sig/moderation_api/models/actions/execute_execute_params.rbs +63 -0
  211. data/sig/moderation_api/models/actions/execute_execute_response.rbs +15 -0
  212. data/sig/moderation_api/models/auth_create_params.rbs +15 -0
  213. data/sig/moderation_api/models/auth_create_response.rbs +18 -0
  214. data/sig/moderation_api/models/auth_retrieve_params.rbs +15 -0
  215. data/sig/moderation_api/models/auth_retrieve_response.rbs +15 -0
  216. data/sig/moderation_api/models/author_create_params.rbs +106 -0
  217. data/sig/moderation_api/models/author_create_response.rbs +195 -0
  218. data/sig/moderation_api/models/author_delete_params.rbs +15 -0
  219. data/sig/moderation_api/models/author_delete_response.rbs +13 -0
  220. data/sig/moderation_api/models/author_list_params.rbs +110 -0
  221. data/sig/moderation_api/models/author_list_response.rbs +254 -0
  222. data/sig/moderation_api/models/author_retrieve_params.rbs +15 -0
  223. data/sig/moderation_api/models/author_retrieve_response.rbs +195 -0
  224. data/sig/moderation_api/models/author_update_params.rbs +101 -0
  225. data/sig/moderation_api/models/author_update_response.rbs +195 -0
  226. data/sig/moderation_api/models/content_submit_params.rbs +733 -0
  227. data/sig/moderation_api/models/content_submit_response.rbs +599 -0
  228. data/sig/moderation_api/models/queue/item_list_params.rbs +127 -0
  229. data/sig/moderation_api/models/queue/item_list_response.rbs +209 -0
  230. data/sig/moderation_api/models/queue/item_resolve_params.rbs +32 -0
  231. data/sig/moderation_api/models/queue/item_resolve_response.rbs +26 -0
  232. data/sig/moderation_api/models/queue/item_unresolve_params.rbs +32 -0
  233. data/sig/moderation_api/models/queue/item_unresolve_response.rbs +24 -0
  234. data/sig/moderation_api/models/queue_get_stats_params.rbs +26 -0
  235. data/sig/moderation_api/models/queue_get_stats_response.rbs +207 -0
  236. data/sig/moderation_api/models/queue_retrieve_params.rbs +15 -0
  237. data/sig/moderation_api/models/queue_retrieve_response.rbs +207 -0
  238. data/sig/moderation_api/models/wordlist/word_add_params.rbs +26 -0
  239. data/sig/moderation_api/models/wordlist/word_add_response.rbs +28 -0
  240. data/sig/moderation_api/models/wordlist/word_remove_params.rbs +26 -0
  241. data/sig/moderation_api/models/wordlist/word_remove_response.rbs +32 -0
  242. data/sig/moderation_api/models/wordlist_get_embedding_status_params.rbs +15 -0
  243. data/sig/moderation_api/models/wordlist_get_embedding_status_response.rbs +26 -0
  244. data/sig/moderation_api/models/wordlist_list_params.rbs +15 -0
  245. data/sig/moderation_api/models/wordlist_list_response.rbs +45 -0
  246. data/sig/moderation_api/models/wordlist_retrieve_params.rbs +15 -0
  247. data/sig/moderation_api/models/wordlist_retrieve_response.rbs +50 -0
  248. data/sig/moderation_api/models/wordlist_update_params.rbs +56 -0
  249. data/sig/moderation_api/models/wordlist_update_response.rbs +50 -0
  250. data/sig/moderation_api/models.rbs +47 -0
  251. data/sig/moderation_api/request_options.rbs +36 -0
  252. data/sig/moderation_api/resources/account.rbs +11 -0
  253. data/sig/moderation_api/resources/actions/execute.rbs +28 -0
  254. data/sig/moderation_api/resources/actions.rbs +57 -0
  255. data/sig/moderation_api/resources/auth.rbs +15 -0
  256. data/sig/moderation_api/resources/authors.rbs +54 -0
  257. data/sig/moderation_api/resources/content.rbs +20 -0
  258. data/sig/moderation_api/resources/queue/items.rbs +39 -0
  259. data/sig/moderation_api/resources/queue.rbs +20 -0
  260. data/sig/moderation_api/resources/wordlist/words.rbs +21 -0
  261. data/sig/moderation_api/resources/wordlist.rbs +33 -0
  262. data/sig/moderation_api/version.rbs +3 -0
  263. metadata +277 -302
  264. data/Gemfile +0 -9
  265. data/Gemfile.lock +0 -87
  266. data/Rakefile +0 -10
  267. data/docs/AccountApi.md +0 -74
  268. data/docs/AccountGet200Response.md +0 -26
  269. data/docs/AccountGet200ResponseCurrentProject.md +0 -20
  270. data/docs/ActionsCreateRequest.md +0 -36
  271. data/docs/ActionsCreateRequestWebhooksInner.md +0 -24
  272. data/docs/ActionsDelete200Response.md +0 -20
  273. data/docs/ActionsExecute200Response.md +0 -22
  274. data/docs/ActionsExecuteDeprecatedRequest.md +0 -22
  275. data/docs/ActionsExecuteRequest.md +0 -24
  276. data/docs/ActionsGet200Response.md +0 -40
  277. data/docs/ActionsGet200ResponseWebhooksInner.md +0 -26
  278. data/docs/ActionsList200ResponseInner.md +0 -38
  279. data/docs/ActionsList200ResponseInnerPossibleValuesInner.md +0 -18
  280. data/docs/ActionsList400Response.md +0 -22
  281. data/docs/ActionsList400ResponseIssuesInner.md +0 -18
  282. data/docs/ActionsUpdateRequest.md +0 -36
  283. data/docs/ModerateApi.md +0 -357
  284. data/docs/ModerationAudioRequest.md +0 -28
  285. data/docs/ModerationImage200Response.md +0 -28
  286. data/docs/ModerationImage200ResponseLabelsInner.md +0 -20
  287. data/docs/ModerationImageRequest.md +0 -28
  288. data/docs/ModerationObject200Response.md +0 -36
  289. data/docs/ModerationObject200ResponseAllOfEntitiesInner.md +0 -22
  290. data/docs/ModerationObject200ResponseAllOfFieldsInner.md +0 -22
  291. data/docs/ModerationObject200ResponseAllOfLabelsInner.md +0 -22
  292. data/docs/ModerationObjectRequest.md +0 -28
  293. data/docs/ModerationObjectRequestValue.md +0 -20
  294. data/docs/ModerationObjectRequestValueDataValue.md +0 -22
  295. data/docs/ModerationText200Response.md +0 -64
  296. data/docs/ModerationText200ResponseAllOfAddress.md +0 -28
  297. data/docs/ModerationText200ResponseAllOfEmail.md +0 -28
  298. data/docs/ModerationText200ResponseAllOfName.md +0 -28
  299. data/docs/ModerationText200ResponseAllOfNsfw.md +0 -26
  300. data/docs/ModerationText200ResponseAllOfNsfwLabelScores.md +0 -22
  301. data/docs/ModerationText200ResponseAllOfPhone.md +0 -28
  302. data/docs/ModerationText200ResponseAllOfProfanity.md +0 -28
  303. data/docs/ModerationText200ResponseAllOfPropriety.md +0 -26
  304. data/docs/ModerationText200ResponseAllOfProprietyLabelScores.md +0 -22
  305. data/docs/ModerationText200ResponseAllOfQuality.md +0 -26
  306. data/docs/ModerationText200ResponseAllOfQualityLabelScores.md +0 -24
  307. data/docs/ModerationText200ResponseAllOfRequest.md +0 -20
  308. data/docs/ModerationText200ResponseAllOfSensitive.md +0 -28
  309. data/docs/ModerationText200ResponseAllOfSentiment.md +0 -26
  310. data/docs/ModerationText200ResponseAllOfSentimentLabelScores.md +0 -22
  311. data/docs/ModerationText200ResponseAllOfToxicity.md +0 -26
  312. data/docs/ModerationText200ResponseAllOfToxicityLabelScores.md +0 -30
  313. data/docs/ModerationText200ResponseAllOfUrl.md +0 -28
  314. data/docs/ModerationText200ResponseAllOfUsername.md +0 -28
  315. data/docs/ModerationText200ResponseAllOfWordlist.md +0 -28
  316. data/docs/ModerationText200ResponseAllOfWordlistsInner.md +0 -36
  317. data/docs/ModerationTextRequest.md +0 -28
  318. data/docs/ModerationVideo200Response.md +0 -24
  319. data/docs/ModerationVideoRequest.md +0 -28
  320. data/docs/QueueActionsApi.md +0 -503
  321. data/git_push.sh +0 -57
  322. data/lib/moderation_api/api/account_api.rb +0 -79
  323. data/lib/moderation_api/api/moderate_api.rb +0 -362
  324. data/lib/moderation_api/api/queue_actions_api.rb +0 -492
  325. data/lib/moderation_api/api_client.rb +0 -437
  326. data/lib/moderation_api/api_error.rb +0 -58
  327. data/lib/moderation_api/configuration.rb +0 -392
  328. data/lib/moderation_api/models/account_get200_response.rb +0 -278
  329. data/lib/moderation_api/models/account_get200_response_current_project.rb +0 -237
  330. data/lib/moderation_api/models/actions_create_request.rb +0 -374
  331. data/lib/moderation_api/models/actions_create_request_webhooks_inner.rb +0 -260
  332. data/lib/moderation_api/models/actions_delete200_response.rb +0 -239
  333. data/lib/moderation_api/models/actions_execute200_response.rb +0 -258
  334. data/lib/moderation_api/models/actions_execute_deprecated_request.rb +0 -244
  335. data/lib/moderation_api/models/actions_execute_request.rb +0 -261
  336. data/lib/moderation_api/models/actions_get200_response.rb +0 -408
  337. data/lib/moderation_api/models/actions_get200_response_webhooks_inner.rb +0 -278
  338. data/lib/moderation_api/models/actions_list200_response_inner.rb +0 -396
  339. data/lib/moderation_api/models/actions_list200_response_inner_possible_values_inner.rb +0 -222
  340. data/lib/moderation_api/models/actions_list400_response.rb +0 -248
  341. data/lib/moderation_api/models/actions_list400_response_issues_inner.rb +0 -221
  342. data/lib/moderation_api/models/actions_update_request.rb +0 -367
  343. data/lib/moderation_api/models/moderation_audio_request.rb +0 -302
  344. data/lib/moderation_api/models/moderation_image200_response.rb +0 -296
  345. data/lib/moderation_api/models/moderation_image200_response_labels_inner.rb +0 -301
  346. data/lib/moderation_api/models/moderation_image_request.rb +0 -302
  347. data/lib/moderation_api/models/moderation_object200_response.rb +0 -368
  348. data/lib/moderation_api/models/moderation_object200_response_all_of_entities_inner.rb +0 -251
  349. data/lib/moderation_api/models/moderation_object200_response_all_of_fields_inner.rb +0 -258
  350. data/lib/moderation_api/models/moderation_object200_response_all_of_labels_inner.rb +0 -284
  351. data/lib/moderation_api/models/moderation_object_request.rb +0 -301
  352. data/lib/moderation_api/models/moderation_object_request_value.rb +0 -275
  353. data/lib/moderation_api/models/moderation_object_request_value_data_value.rb +0 -285
  354. data/lib/moderation_api/models/moderation_text200_response.rb +0 -488
  355. data/lib/moderation_api/models/moderation_text200_response_all_of_address.rb +0 -303
  356. data/lib/moderation_api/models/moderation_text200_response_all_of_email.rb +0 -303
  357. data/lib/moderation_api/models/moderation_text200_response_all_of_name.rb +0 -303
  358. data/lib/moderation_api/models/moderation_text200_response_all_of_nsfw.rb +0 -255
  359. data/lib/moderation_api/models/moderation_text200_response_all_of_nsfw_label_scores.rb +0 -235
  360. data/lib/moderation_api/models/moderation_text200_response_all_of_phone.rb +0 -303
  361. data/lib/moderation_api/models/moderation_text200_response_all_of_profanity.rb +0 -303
  362. data/lib/moderation_api/models/moderation_text200_response_all_of_propriety.rb +0 -255
  363. data/lib/moderation_api/models/moderation_text200_response_all_of_propriety_label_scores.rb +0 -235
  364. data/lib/moderation_api/models/moderation_text200_response_all_of_quality.rb +0 -255
  365. data/lib/moderation_api/models/moderation_text200_response_all_of_quality_label_scores.rb +0 -245
  366. data/lib/moderation_api/models/moderation_text200_response_all_of_request.rb +0 -240
  367. data/lib/moderation_api/models/moderation_text200_response_all_of_sensitive.rb +0 -303
  368. data/lib/moderation_api/models/moderation_text200_response_all_of_sentiment.rb +0 -255
  369. data/lib/moderation_api/models/moderation_text200_response_all_of_sentiment_label_scores.rb +0 -235
  370. data/lib/moderation_api/models/moderation_text200_response_all_of_toxicity.rb +0 -262
  371. data/lib/moderation_api/models/moderation_text200_response_all_of_toxicity_label_scores.rb +0 -275
  372. data/lib/moderation_api/models/moderation_text200_response_all_of_url.rb +0 -303
  373. data/lib/moderation_api/models/moderation_text200_response_all_of_username.rb +0 -303
  374. data/lib/moderation_api/models/moderation_text200_response_all_of_wordlist.rb +0 -303
  375. data/lib/moderation_api/models/moderation_text200_response_all_of_wordlists_inner.rb +0 -377
  376. data/lib/moderation_api/models/moderation_text_request.rb +0 -330
  377. data/lib/moderation_api/models/moderation_video200_response.rb +0 -265
  378. data/lib/moderation_api/models/moderation_video_request.rb +0 -302
  379. data/lib/moderation_api/webhook.rb +0 -41
  380. data/moderation_api-1.2.0.gem +0 -0
  381. data/moderation_api-1.2.1.gem +0 -0
  382. data/moderation_api.gemspec +0 -45
  383. data/ruby_config.yaml +0 -30
  384. data/spec/api/account_api_spec.rb +0 -46
  385. data/spec/api/moderate_api_spec.rb +0 -95
  386. data/spec/api/queue_actions_api_spec.rb +0 -121
  387. data/spec/models/account_get200_response_current_project_spec.rb +0 -42
  388. data/spec/models/account_get200_response_spec.rb +0 -60
  389. data/spec/models/actions_create_request_spec.rb +0 -98
  390. data/spec/models/actions_create_request_webhooks_inner_spec.rb +0 -54
  391. data/spec/models/actions_delete200_response_spec.rb +0 -42
  392. data/spec/models/actions_execute200_response_spec.rb +0 -48
  393. data/spec/models/actions_execute_deprecated_request_spec.rb +0 -48
  394. data/spec/models/actions_execute_request_spec.rb +0 -54
  395. data/spec/models/actions_get200_response_spec.rb +0 -110
  396. data/spec/models/actions_get200_response_webhooks_inner_spec.rb +0 -60
  397. data/spec/models/actions_list200_response_inner_possible_values_inner_spec.rb +0 -36
  398. data/spec/models/actions_list200_response_inner_spec.rb +0 -104
  399. data/spec/models/actions_list400_response_issues_inner_spec.rb +0 -36
  400. data/spec/models/actions_list400_response_spec.rb +0 -48
  401. data/spec/models/actions_update_request_spec.rb +0 -98
  402. data/spec/models/moderation_audio_request_spec.rb +0 -66
  403. data/spec/models/moderation_image200_response_labels_inner_spec.rb +0 -46
  404. data/spec/models/moderation_image200_response_spec.rb +0 -66
  405. data/spec/models/moderation_image_request_spec.rb +0 -66
  406. data/spec/models/moderation_object200_response_all_of_entities_inner_spec.rb +0 -48
  407. data/spec/models/moderation_object200_response_all_of_fields_inner_spec.rb +0 -48
  408. data/spec/models/moderation_object200_response_all_of_labels_inner_spec.rb +0 -48
  409. data/spec/models/moderation_object200_response_spec.rb +0 -90
  410. data/spec/models/moderation_object_request_spec.rb +0 -66
  411. data/spec/models/moderation_object_request_value_data_value_spec.rb +0 -52
  412. data/spec/models/moderation_object_request_value_spec.rb +0 -46
  413. data/spec/models/moderation_text200_response_all_of_address_spec.rb +0 -70
  414. data/spec/models/moderation_text200_response_all_of_email_spec.rb +0 -70
  415. data/spec/models/moderation_text200_response_all_of_name_spec.rb +0 -70
  416. data/spec/models/moderation_text200_response_all_of_nsfw_label_scores_spec.rb +0 -48
  417. data/spec/models/moderation_text200_response_all_of_nsfw_spec.rb +0 -60
  418. data/spec/models/moderation_text200_response_all_of_phone_spec.rb +0 -70
  419. data/spec/models/moderation_text200_response_all_of_profanity_spec.rb +0 -70
  420. data/spec/models/moderation_text200_response_all_of_propriety_label_scores_spec.rb +0 -48
  421. data/spec/models/moderation_text200_response_all_of_propriety_spec.rb +0 -60
  422. data/spec/models/moderation_text200_response_all_of_quality_label_scores_spec.rb +0 -54
  423. data/spec/models/moderation_text200_response_all_of_quality_spec.rb +0 -60
  424. data/spec/models/moderation_text200_response_all_of_request_spec.rb +0 -42
  425. data/spec/models/moderation_text200_response_all_of_sensitive_spec.rb +0 -70
  426. data/spec/models/moderation_text200_response_all_of_sentiment_label_scores_spec.rb +0 -48
  427. data/spec/models/moderation_text200_response_all_of_sentiment_spec.rb +0 -60
  428. data/spec/models/moderation_text200_response_all_of_toxicity_label_scores_spec.rb +0 -72
  429. data/spec/models/moderation_text200_response_all_of_toxicity_spec.rb +0 -60
  430. data/spec/models/moderation_text200_response_all_of_url_spec.rb +0 -70
  431. data/spec/models/moderation_text200_response_all_of_username_spec.rb +0 -70
  432. data/spec/models/moderation_text200_response_all_of_wordlist_spec.rb +0 -70
  433. data/spec/models/moderation_text200_response_all_of_wordlists_inner_spec.rb +0 -94
  434. data/spec/models/moderation_text200_response_spec.rb +0 -174
  435. data/spec/models/moderation_text_request_spec.rb +0 -66
  436. data/spec/models/moderation_video200_response_spec.rb +0 -54
  437. data/spec/models/moderation_video_request_spec.rb +0 -66
  438. data/spec/spec_helper.rb +0 -111
@@ -0,0 +1,742 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ModerationAPI
4
+ module Models
5
+ # @see ModerationAPI::Resources::Content#submit
6
+ class ContentSubmitResponse < ModerationAPI::Internal::Type::BaseModel
7
+ # @!attribute author
8
+ # The author of the content if your account has authors enabled. Requires you to
9
+ # send authorId when submitting content.
10
+ #
11
+ # @return [ModerationAPI::Models::ContentSubmitResponse::Author, nil]
12
+ required :author, -> { ModerationAPI::Models::ContentSubmitResponse::Author }, nil?: true
13
+
14
+ # @!attribute content
15
+ # Potentially modified content.
16
+ #
17
+ # @return [ModerationAPI::Models::ContentSubmitResponse::Content]
18
+ required :content, -> { ModerationAPI::Models::ContentSubmitResponse::Content }
19
+
20
+ # @!attribute evaluation
21
+ # The evaluation of the content after running the channel policies.
22
+ #
23
+ # @return [ModerationAPI::Models::ContentSubmitResponse::Evaluation]
24
+ required :evaluation, -> { ModerationAPI::Models::ContentSubmitResponse::Evaluation }
25
+
26
+ # @!attribute insights
27
+ # Results of all insights enabled in the channel.
28
+ #
29
+ # @return [Array<ModerationAPI::Models::ContentSubmitResponse::Insight::SentimentInsight, ModerationAPI::Models::ContentSubmitResponse::Insight::LanguageInsight>]
30
+ required :insights,
31
+ -> { ModerationAPI::Internal::Type::ArrayOf[union: ModerationAPI::Models::ContentSubmitResponse::Insight] }
32
+
33
+ # @!attribute meta
34
+ # Metadata about the moderation request
35
+ #
36
+ # @return [ModerationAPI::Models::ContentSubmitResponse::Meta]
37
+ required :meta, -> { ModerationAPI::Models::ContentSubmitResponse::Meta }
38
+
39
+ # @!attribute policies
40
+ # Results of all policies in the channel. Sorted by highest probability.
41
+ #
42
+ # @return [Array<ModerationAPI::Models::ContentSubmitResponse::Policy::ClassifierOutput, ModerationAPI::Models::ContentSubmitResponse::Policy::EntityMatcherOutput>]
43
+ required :policies,
44
+ -> { ModerationAPI::Internal::Type::ArrayOf[union: ModerationAPI::Models::ContentSubmitResponse::Policy] }
45
+
46
+ # @!attribute recommendation
47
+ # The recommendation for the content based on the evaluation.
48
+ #
49
+ # @return [ModerationAPI::Models::ContentSubmitResponse::Recommendation]
50
+ required :recommendation, -> { ModerationAPI::Models::ContentSubmitResponse::Recommendation }
51
+
52
+ # @!attribute errors
53
+ # Policies that had errors
54
+ #
55
+ # @return [Array<ModerationAPI::Models::ContentSubmitResponse::Error>, nil]
56
+ optional :errors,
57
+ -> { ModerationAPI::Internal::Type::ArrayOf[ModerationAPI::Models::ContentSubmitResponse::Error] }
58
+
59
+ # @!method initialize(author:, content:, evaluation:, insights:, meta:, policies:, recommendation:, errors: nil)
60
+ # Some parameter documentations has been truncated, see
61
+ # {ModerationAPI::Models::ContentSubmitResponse} for more details.
62
+ #
63
+ # @param author [ModerationAPI::Models::ContentSubmitResponse::Author, nil] The author of the content if your account has authors enabled. Requires you to s
64
+ #
65
+ # @param content [ModerationAPI::Models::ContentSubmitResponse::Content] Potentially modified content.
66
+ #
67
+ # @param evaluation [ModerationAPI::Models::ContentSubmitResponse::Evaluation] The evaluation of the content after running the channel policies.
68
+ #
69
+ # @param insights [Array<ModerationAPI::Models::ContentSubmitResponse::Insight::SentimentInsight, ModerationAPI::Models::ContentSubmitResponse::Insight::LanguageInsight>] Results of all insights enabled in the channel.
70
+ #
71
+ # @param meta [ModerationAPI::Models::ContentSubmitResponse::Meta] Metadata about the moderation request
72
+ #
73
+ # @param policies [Array<ModerationAPI::Models::ContentSubmitResponse::Policy::ClassifierOutput, ModerationAPI::Models::ContentSubmitResponse::Policy::EntityMatcherOutput>] Results of all policies in the channel. Sorted by highest probability.
74
+ #
75
+ # @param recommendation [ModerationAPI::Models::ContentSubmitResponse::Recommendation] The recommendation for the content based on the evaluation.
76
+ #
77
+ # @param errors [Array<ModerationAPI::Models::ContentSubmitResponse::Error>] Policies that had errors
78
+
79
+ # @see ModerationAPI::Models::ContentSubmitResponse#author
80
+ class Author < ModerationAPI::Internal::Type::BaseModel
81
+ # @!attribute id
82
+ # Author ID in Moderation API
83
+ #
84
+ # @return [String]
85
+ required :id, String
86
+
87
+ # @!attribute block
88
+ # Block or suspension details, if applicable. Null if the author is enabled.
89
+ #
90
+ # @return [ModerationAPI::Models::ContentSubmitResponse::Author::Block, nil]
91
+ required :block, -> { ModerationAPI::Models::ContentSubmitResponse::Author::Block }, nil?: true
92
+
93
+ # @!attribute status
94
+ # Current author status
95
+ #
96
+ # @return [Symbol, ModerationAPI::Models::ContentSubmitResponse::Author::Status]
97
+ required :status, enum: -> { ModerationAPI::Models::ContentSubmitResponse::Author::Status }
98
+
99
+ # @!attribute trust_level
100
+ #
101
+ # @return [ModerationAPI::Models::ContentSubmitResponse::Author::TrustLevel]
102
+ required :trust_level, -> { ModerationAPI::Models::ContentSubmitResponse::Author::TrustLevel }
103
+
104
+ # @!attribute external_id
105
+ # The author's ID from your system
106
+ #
107
+ # @return [String, nil]
108
+ optional :external_id, String, nil?: true
109
+
110
+ # @!method initialize(id:, block:, status:, trust_level:, external_id: nil)
111
+ # The author of the content if your account has authors enabled. Requires you to
112
+ # send authorId when submitting content.
113
+ #
114
+ # @param id [String] Author ID in Moderation API
115
+ #
116
+ # @param block [ModerationAPI::Models::ContentSubmitResponse::Author::Block, nil] Block or suspension details, if applicable. Null if the author is enabled.
117
+ #
118
+ # @param status [Symbol, ModerationAPI::Models::ContentSubmitResponse::Author::Status] Current author status
119
+ #
120
+ # @param trust_level [ModerationAPI::Models::ContentSubmitResponse::Author::TrustLevel]
121
+ #
122
+ # @param external_id [String, nil] The author's ID from your system
123
+
124
+ # @see ModerationAPI::Models::ContentSubmitResponse::Author#block
125
+ class Block < ModerationAPI::Internal::Type::BaseModel
126
+ # @!attribute reason
127
+ # The moderators reason why the author was blocked or suspended.
128
+ #
129
+ # @return [String, nil]
130
+ optional :reason, String, nil?: true
131
+
132
+ # @!attribute until_
133
+ # The timestamp until which they are blocked if the author is suspended.
134
+ #
135
+ # @return [Float, nil]
136
+ optional :until_, Float, api_name: :until, nil?: true
137
+
138
+ # @!method initialize(reason: nil, until_: nil)
139
+ # Block or suspension details, if applicable. Null if the author is enabled.
140
+ #
141
+ # @param reason [String, nil] The moderators reason why the author was blocked or suspended.
142
+ #
143
+ # @param until_ [Float, nil] The timestamp until which they are blocked if the author is suspended.
144
+ end
145
+
146
+ # Current author status
147
+ #
148
+ # @see ModerationAPI::Models::ContentSubmitResponse::Author#status
149
+ module Status
150
+ extend ModerationAPI::Internal::Type::Enum
151
+
152
+ ENABLED = :enabled
153
+ SUSPENDED = :suspended
154
+ BLOCKED = :blocked
155
+
156
+ # @!method self.values
157
+ # @return [Array<Symbol>]
158
+ end
159
+
160
+ # @see ModerationAPI::Models::ContentSubmitResponse::Author#trust_level
161
+ class TrustLevel < ModerationAPI::Internal::Type::BaseModel
162
+ # @!attribute level
163
+ # Author trust level (-1, 0, 1, 2, 3, or 4)
164
+ #
165
+ # @return [Float]
166
+ required :level, Float
167
+
168
+ # @!attribute manual
169
+ # True if the trust level was set manually by a moderator
170
+ #
171
+ # @return [Boolean]
172
+ required :manual, ModerationAPI::Internal::Type::Boolean
173
+
174
+ # @!method initialize(level:, manual:)
175
+ # @param level [Float] Author trust level (-1, 0, 1, 2, 3, or 4)
176
+ #
177
+ # @param manual [Boolean] True if the trust level was set manually by a moderator
178
+ end
179
+ end
180
+
181
+ # @see ModerationAPI::Models::ContentSubmitResponse#content
182
+ class Content < ModerationAPI::Internal::Type::BaseModel
183
+ # @!attribute id
184
+ # The unique identifier for the content. Either the contentId provided by you or
185
+ # an autogenerated ID.
186
+ #
187
+ # @return [String]
188
+ required :id, String
189
+
190
+ # @!attribute masked
191
+ # Whether any values have been masked.
192
+ #
193
+ # @return [Boolean]
194
+ required :masked, ModerationAPI::Internal::Type::Boolean
195
+
196
+ # @!attribute modified
197
+ # The modified content, if any.
198
+ #
199
+ # @return [String, Hash{Symbol=>ModerationAPI::Models::ContentSubmitResponse::Content::Modified::UnionMember1::Text, ModerationAPI::Models::ContentSubmitResponse::Content::Modified::UnionMember1::Image, ModerationAPI::Models::ContentSubmitResponse::Content::Modified::UnionMember1::Video, ModerationAPI::Models::ContentSubmitResponse::Content::Modified::UnionMember1::Audio}, nil]
200
+ required :modified,
201
+ union: -> { ModerationAPI::Models::ContentSubmitResponse::Content::Modified },
202
+ nil?: true
203
+
204
+ # @!method initialize(id:, masked:, modified:)
205
+ # Some parameter documentations has been truncated, see
206
+ # {ModerationAPI::Models::ContentSubmitResponse::Content} for more details.
207
+ #
208
+ # Potentially modified content.
209
+ #
210
+ # @param id [String] The unique identifier for the content. Either the contentId provided by you or a
211
+ #
212
+ # @param masked [Boolean] Whether any values have been masked.
213
+ #
214
+ # @param modified [String, Hash{Symbol=>ModerationAPI::Models::ContentSubmitResponse::Content::Modified::UnionMember1::Text, ModerationAPI::Models::ContentSubmitResponse::Content::Modified::UnionMember1::Image, ModerationAPI::Models::ContentSubmitResponse::Content::Modified::UnionMember1::Video, ModerationAPI::Models::ContentSubmitResponse::Content::Modified::UnionMember1::Audio}, nil] The modified content, if any.
215
+
216
+ # The modified content, if any.
217
+ #
218
+ # @see ModerationAPI::Models::ContentSubmitResponse::Content#modified
219
+ module Modified
220
+ extend ModerationAPI::Internal::Type::Union
221
+
222
+ variant String
223
+
224
+ variant -> { ModerationAPI::Models::ContentSubmitResponse::Content::Modified::UnionMember1Map }
225
+
226
+ # Text
227
+ module UnionMember1
228
+ extend ModerationAPI::Internal::Type::Union
229
+
230
+ # Text
231
+ variant -> { ModerationAPI::Models::ContentSubmitResponse::Content::Modified::UnionMember1::Text }
232
+
233
+ # Image
234
+ variant -> { ModerationAPI::Models::ContentSubmitResponse::Content::Modified::UnionMember1::Image }
235
+
236
+ # Video
237
+ variant -> { ModerationAPI::Models::ContentSubmitResponse::Content::Modified::UnionMember1::Video }
238
+
239
+ # Audio
240
+ variant -> { ModerationAPI::Models::ContentSubmitResponse::Content::Modified::UnionMember1::Audio }
241
+
242
+ class Text < ModerationAPI::Internal::Type::BaseModel
243
+ # @!attribute text
244
+ # The content text
245
+ #
246
+ # @return [String]
247
+ required :text, String
248
+
249
+ # @!attribute type
250
+ #
251
+ # @return [Symbol, :text]
252
+ required :type, const: :text
253
+
254
+ # @!method initialize(text:, type: :text)
255
+ # Text
256
+ #
257
+ # @param text [String] The content text
258
+ #
259
+ # @param type [Symbol, :text]
260
+ end
261
+
262
+ class Image < ModerationAPI::Internal::Type::BaseModel
263
+ # @!attribute type
264
+ #
265
+ # @return [Symbol, :image]
266
+ required :type, const: :image
267
+
268
+ # @!attribute url
269
+ # A public URL of the image content
270
+ #
271
+ # @return [String]
272
+ required :url, String
273
+
274
+ # @!method initialize(url:, type: :image)
275
+ # Image
276
+ #
277
+ # @param url [String] A public URL of the image content
278
+ #
279
+ # @param type [Symbol, :image]
280
+ end
281
+
282
+ class Video < ModerationAPI::Internal::Type::BaseModel
283
+ # @!attribute type
284
+ #
285
+ # @return [Symbol, :video]
286
+ required :type, const: :video
287
+
288
+ # @!attribute url
289
+ # A public URL of the video content
290
+ #
291
+ # @return [String]
292
+ required :url, String
293
+
294
+ # @!method initialize(url:, type: :video)
295
+ # Video
296
+ #
297
+ # @param url [String] A public URL of the video content
298
+ #
299
+ # @param type [Symbol, :video]
300
+ end
301
+
302
+ class Audio < ModerationAPI::Internal::Type::BaseModel
303
+ # @!attribute type
304
+ #
305
+ # @return [Symbol, :audio]
306
+ required :type, const: :audio
307
+
308
+ # @!attribute url
309
+ # The URL of the audio content
310
+ #
311
+ # @return [String]
312
+ required :url, String
313
+
314
+ # @!method initialize(url:, type: :audio)
315
+ # Audio
316
+ #
317
+ # @param url [String] The URL of the audio content
318
+ #
319
+ # @param type [Symbol, :audio]
320
+ end
321
+
322
+ # @!method self.variants
323
+ # @return [Array(ModerationAPI::Models::ContentSubmitResponse::Content::Modified::UnionMember1::Text, ModerationAPI::Models::ContentSubmitResponse::Content::Modified::UnionMember1::Image, ModerationAPI::Models::ContentSubmitResponse::Content::Modified::UnionMember1::Video, ModerationAPI::Models::ContentSubmitResponse::Content::Modified::UnionMember1::Audio)]
324
+ end
325
+
326
+ # @!method self.variants
327
+ # @return [Array(String, Hash{Symbol=>ModerationAPI::Models::ContentSubmitResponse::Content::Modified::UnionMember1::Text, ModerationAPI::Models::ContentSubmitResponse::Content::Modified::UnionMember1::Image, ModerationAPI::Models::ContentSubmitResponse::Content::Modified::UnionMember1::Video, ModerationAPI::Models::ContentSubmitResponse::Content::Modified::UnionMember1::Audio})]
328
+
329
+ # @type [ModerationAPI::Internal::Type::Converter]
330
+ UnionMember1Map =
331
+ ModerationAPI::Internal::Type::HashOf[union: -> { ModerationAPI::Models::ContentSubmitResponse::Content::Modified::UnionMember1 }]
332
+ end
333
+ end
334
+
335
+ # @see ModerationAPI::Models::ContentSubmitResponse#evaluation
336
+ class Evaluation < ModerationAPI::Internal::Type::BaseModel
337
+ # @!attribute flag_probability
338
+ # The probability that the content should be flagged.
339
+ #
340
+ # @return [Float]
341
+ required :flag_probability, Float
342
+
343
+ # @!attribute flagged
344
+ # Whether the content was flagged by any policy.
345
+ #
346
+ # @return [Boolean]
347
+ required :flagged, ModerationAPI::Internal::Type::Boolean
348
+
349
+ # @!attribute severity_score
350
+ # The severity score of the content. A higher score indicates more severe content.
351
+ #
352
+ # @return [Float]
353
+ required :severity_score, Float
354
+
355
+ # @!attribute unicode_spoofed
356
+ # Whether the content was flagged for Unicode spoofing.
357
+ #
358
+ # @return [Boolean, nil]
359
+ optional :unicode_spoofed, ModerationAPI::Internal::Type::Boolean
360
+
361
+ # @!method initialize(flag_probability:, flagged:, severity_score:, unicode_spoofed: nil)
362
+ # Some parameter documentations has been truncated, see
363
+ # {ModerationAPI::Models::ContentSubmitResponse::Evaluation} for more details.
364
+ #
365
+ # The evaluation of the content after running the channel policies.
366
+ #
367
+ # @param flag_probability [Float] The probability that the content should be flagged.
368
+ #
369
+ # @param flagged [Boolean] Whether the content was flagged by any policy.
370
+ #
371
+ # @param severity_score [Float] The severity score of the content. A higher score indicates more severe content.
372
+ #
373
+ # @param unicode_spoofed [Boolean] Whether the content was flagged for Unicode spoofing.
374
+ end
375
+
376
+ # Sentiment insight
377
+ module Insight
378
+ extend ModerationAPI::Internal::Type::Union
379
+
380
+ # Sentiment insight
381
+ variant -> { ModerationAPI::Models::ContentSubmitResponse::Insight::SentimentInsight }
382
+
383
+ # Language insight
384
+ variant -> { ModerationAPI::Models::ContentSubmitResponse::Insight::LanguageInsight }
385
+
386
+ class SentimentInsight < ModerationAPI::Internal::Type::BaseModel
387
+ # @!attribute id
388
+ #
389
+ # @return [Symbol, :sentiment]
390
+ required :id, const: :sentiment
391
+
392
+ # @!attribute probability
393
+ #
394
+ # @return [Float]
395
+ required :probability, Float
396
+
397
+ # @!attribute type
398
+ #
399
+ # @return [Symbol, :insight]
400
+ required :type, const: :insight
401
+
402
+ # @!attribute value
403
+ #
404
+ # @return [Symbol, ModerationAPI::Models::ContentSubmitResponse::Insight::SentimentInsight::Value, nil]
405
+ required :value,
406
+ enum: -> { ModerationAPI::Models::ContentSubmitResponse::Insight::SentimentInsight::Value },
407
+ nil?: true
408
+
409
+ # @!method initialize(probability:, value:, id: :sentiment, type: :insight)
410
+ # Sentiment insight
411
+ #
412
+ # @param probability [Float]
413
+ # @param value [Symbol, ModerationAPI::Models::ContentSubmitResponse::Insight::SentimentInsight::Value, nil]
414
+ # @param id [Symbol, :sentiment]
415
+ # @param type [Symbol, :insight]
416
+
417
+ # @see ModerationAPI::Models::ContentSubmitResponse::Insight::SentimentInsight#value
418
+ module Value
419
+ extend ModerationAPI::Internal::Type::Enum
420
+
421
+ POSITIVE = :positive
422
+ NEUTRAL = :neutral
423
+ NEGATIVE = :negative
424
+
425
+ # @!method self.values
426
+ # @return [Array<Symbol>]
427
+ end
428
+ end
429
+
430
+ class LanguageInsight < ModerationAPI::Internal::Type::BaseModel
431
+ # @!attribute id
432
+ #
433
+ # @return [Symbol, :language]
434
+ required :id, const: :language
435
+
436
+ # @!attribute probability
437
+ #
438
+ # @return [Float]
439
+ required :probability, Float
440
+
441
+ # @!attribute type
442
+ #
443
+ # @return [Symbol, :insight]
444
+ required :type, const: :insight
445
+
446
+ # @!attribute value
447
+ #
448
+ # @return [String, nil]
449
+ required :value, String, nil?: true
450
+
451
+ # @!method initialize(probability:, value:, id: :language, type: :insight)
452
+ # Language insight
453
+ #
454
+ # @param probability [Float]
455
+ # @param value [String, nil]
456
+ # @param id [Symbol, :language]
457
+ # @param type [Symbol, :insight]
458
+ end
459
+
460
+ # @!method self.variants
461
+ # @return [Array(ModerationAPI::Models::ContentSubmitResponse::Insight::SentimentInsight, ModerationAPI::Models::ContentSubmitResponse::Insight::LanguageInsight)]
462
+ end
463
+
464
+ # @see ModerationAPI::Models::ContentSubmitResponse#meta
465
+ class Meta < ModerationAPI::Internal::Type::BaseModel
466
+ # @!attribute channel_key
467
+ # The unique key of the channel where the content was handled. Either the channel
468
+ # provided by you or automatically routed.
469
+ #
470
+ # @return [String]
471
+ required :channel_key, String
472
+
473
+ # @!attribute status
474
+ #
475
+ # @return [Symbol, ModerationAPI::Models::ContentSubmitResponse::Meta::Status]
476
+ required :status, enum: -> { ModerationAPI::Models::ContentSubmitResponse::Meta::Status }
477
+
478
+ # @!attribute timestamp
479
+ #
480
+ # @return [Float]
481
+ required :timestamp, Float
482
+
483
+ # @!attribute usage
484
+ #
485
+ # @return [Float]
486
+ required :usage, Float
487
+
488
+ # @!attribute processing_time
489
+ #
490
+ # @return [String, nil]
491
+ optional :processing_time, String
492
+
493
+ # @!method initialize(channel_key:, status:, timestamp:, usage:, processing_time: nil)
494
+ # Some parameter documentations has been truncated, see
495
+ # {ModerationAPI::Models::ContentSubmitResponse::Meta} for more details.
496
+ #
497
+ # Metadata about the moderation request
498
+ #
499
+ # @param channel_key [String] The unique key of the channel where the content was handled. Either the channel
500
+ #
501
+ # @param status [Symbol, ModerationAPI::Models::ContentSubmitResponse::Meta::Status]
502
+ #
503
+ # @param timestamp [Float]
504
+ #
505
+ # @param usage [Float]
506
+ #
507
+ # @param processing_time [String]
508
+
509
+ # @see ModerationAPI::Models::ContentSubmitResponse::Meta#status
510
+ module Status
511
+ extend ModerationAPI::Internal::Type::Enum
512
+
513
+ SUCCESS = :success
514
+ PARTIAL_SUCCESS = :partial_success
515
+
516
+ # @!method self.values
517
+ # @return [Array<Symbol>]
518
+ end
519
+ end
520
+
521
+ # Policy output schema.
522
+ module Policy
523
+ extend ModerationAPI::Internal::Type::Union
524
+
525
+ # Classifier policy.
526
+ variant -> { ModerationAPI::Models::ContentSubmitResponse::Policy::ClassifierOutput }
527
+
528
+ # Entity matcher policy.
529
+ variant -> { ModerationAPI::Models::ContentSubmitResponse::Policy::EntityMatcherOutput }
530
+
531
+ class ClassifierOutput < ModerationAPI::Internal::Type::BaseModel
532
+ # @!attribute id
533
+ # The unique identifier for the classifier output.
534
+ #
535
+ # @return [String]
536
+ required :id, String
537
+
538
+ # @!attribute flagged
539
+ #
540
+ # @return [Boolean]
541
+ required :flagged, ModerationAPI::Internal::Type::Boolean
542
+
543
+ # @!attribute probability
544
+ #
545
+ # @return [Float]
546
+ required :probability, Float
547
+
548
+ # @!attribute type
549
+ #
550
+ # @return [Symbol, :classifier]
551
+ required :type, const: :classifier
552
+
553
+ # @!attribute flagged_fields
554
+ # The keys of the flagged fields if submitting an object.
555
+ #
556
+ # @return [Array<String>, nil]
557
+ optional :flagged_fields, ModerationAPI::Internal::Type::ArrayOf[String]
558
+
559
+ # @!attribute labels
560
+ #
561
+ # @return [Array<ModerationAPI::Models::ContentSubmitResponse::Policy::ClassifierOutput::Label>, nil]
562
+ optional :labels,
563
+ -> { ModerationAPI::Internal::Type::ArrayOf[ModerationAPI::Models::ContentSubmitResponse::Policy::ClassifierOutput::Label] }
564
+
565
+ # @!method initialize(id:, flagged:, probability:, flagged_fields: nil, labels: nil, type: :classifier)
566
+ # Classifier policy.
567
+ #
568
+ # @param id [String] The unique identifier for the classifier output.
569
+ #
570
+ # @param flagged [Boolean]
571
+ #
572
+ # @param probability [Float]
573
+ #
574
+ # @param flagged_fields [Array<String>] The keys of the flagged fields if submitting an object.
575
+ #
576
+ # @param labels [Array<ModerationAPI::Models::ContentSubmitResponse::Policy::ClassifierOutput::Label>]
577
+ #
578
+ # @param type [Symbol, :classifier]
579
+
580
+ class Label < ModerationAPI::Internal::Type::BaseModel
581
+ # @!attribute id
582
+ #
583
+ # @return [String]
584
+ required :id, String
585
+
586
+ # @!attribute flagged
587
+ #
588
+ # @return [Boolean]
589
+ required :flagged, ModerationAPI::Internal::Type::Boolean
590
+
591
+ # @!attribute probability
592
+ #
593
+ # @return [Float]
594
+ required :probability, Float
595
+
596
+ # @!method initialize(id:, flagged:, probability:)
597
+ # @param id [String]
598
+ # @param flagged [Boolean]
599
+ # @param probability [Float]
600
+ end
601
+ end
602
+
603
+ class EntityMatcherOutput < ModerationAPI::Internal::Type::BaseModel
604
+ # @!attribute id
605
+ #
606
+ # @return [String]
607
+ required :id, String
608
+
609
+ # @!attribute flagged
610
+ #
611
+ # @return [Boolean]
612
+ required :flagged, ModerationAPI::Internal::Type::Boolean
613
+
614
+ # @!attribute matches
615
+ #
616
+ # @return [Array<ModerationAPI::Models::ContentSubmitResponse::Policy::EntityMatcherOutput::Match>]
617
+ required :matches,
618
+ -> { ModerationAPI::Internal::Type::ArrayOf[ModerationAPI::Models::ContentSubmitResponse::Policy::EntityMatcherOutput::Match] }
619
+
620
+ # @!attribute probability
621
+ #
622
+ # @return [Float]
623
+ required :probability, Float
624
+
625
+ # @!attribute type
626
+ #
627
+ # @return [Symbol, :entity_matcher]
628
+ required :type, const: :entity_matcher
629
+
630
+ # @!attribute flagged_fields
631
+ #
632
+ # @return [Array<String>, nil]
633
+ optional :flagged_fields, ModerationAPI::Internal::Type::ArrayOf[String]
634
+
635
+ # @!method initialize(id:, flagged:, matches:, probability:, flagged_fields: nil, type: :entity_matcher)
636
+ # Entity matcher policy.
637
+ #
638
+ # @param id [String]
639
+ # @param flagged [Boolean]
640
+ # @param matches [Array<ModerationAPI::Models::ContentSubmitResponse::Policy::EntityMatcherOutput::Match>]
641
+ # @param probability [Float]
642
+ # @param flagged_fields [Array<String>]
643
+ # @param type [Symbol, :entity_matcher]
644
+
645
+ class Match < ModerationAPI::Internal::Type::BaseModel
646
+ # @!attribute match
647
+ #
648
+ # @return [String]
649
+ required :match, String
650
+
651
+ # @!attribute probability
652
+ #
653
+ # @return [Float]
654
+ required :probability, Float
655
+
656
+ # @!attribute span
657
+ #
658
+ # @return [Array<Integer>]
659
+ required :span, ModerationAPI::Internal::Type::ArrayOf[Integer]
660
+
661
+ # @!method initialize(match:, probability:, span:)
662
+ # @param match [String]
663
+ # @param probability [Float]
664
+ # @param span [Array<Integer>]
665
+ end
666
+ end
667
+
668
+ # @!method self.variants
669
+ # @return [Array(ModerationAPI::Models::ContentSubmitResponse::Policy::ClassifierOutput, ModerationAPI::Models::ContentSubmitResponse::Policy::EntityMatcherOutput)]
670
+ end
671
+
672
+ # @see ModerationAPI::Models::ContentSubmitResponse#recommendation
673
+ class Recommendation < ModerationAPI::Internal::Type::BaseModel
674
+ # @!attribute action
675
+ # The action to take based on the recommendation
676
+ #
677
+ # @return [Symbol, ModerationAPI::Models::ContentSubmitResponse::Recommendation::Action]
678
+ required :action, enum: -> { ModerationAPI::Models::ContentSubmitResponse::Recommendation::Action }
679
+
680
+ # @!attribute reason_codes
681
+ # The reason code for the recommendation. Can be used to display a reason to the
682
+ # user.
683
+ #
684
+ # @return [Array<Symbol, ModerationAPI::Models::ContentSubmitResponse::Recommendation::ReasonCode>]
685
+ required :reason_codes,
686
+ -> { ModerationAPI::Internal::Type::ArrayOf[enum: ModerationAPI::Models::ContentSubmitResponse::Recommendation::ReasonCode] }
687
+
688
+ # @!method initialize(action:, reason_codes:)
689
+ # Some parameter documentations has been truncated, see
690
+ # {ModerationAPI::Models::ContentSubmitResponse::Recommendation} for more details.
691
+ #
692
+ # The recommendation for the content based on the evaluation.
693
+ #
694
+ # @param action [Symbol, ModerationAPI::Models::ContentSubmitResponse::Recommendation::Action] The action to take based on the recommendation
695
+ #
696
+ # @param reason_codes [Array<Symbol, ModerationAPI::Models::ContentSubmitResponse::Recommendation::ReasonCode>] The reason code for the recommendation. Can be used to display a reason to the u
697
+
698
+ # The action to take based on the recommendation
699
+ #
700
+ # @see ModerationAPI::Models::ContentSubmitResponse::Recommendation#action
701
+ module Action
702
+ extend ModerationAPI::Internal::Type::Enum
703
+
704
+ REVIEW = :review
705
+ ALLOW = :allow
706
+ REJECT = :reject
707
+
708
+ # @!method self.values
709
+ # @return [Array<Symbol>]
710
+ end
711
+
712
+ module ReasonCode
713
+ extend ModerationAPI::Internal::Type::Enum
714
+
715
+ SEVERITY_REJECT = :severity_reject
716
+ SEVERITY_REVIEW = :severity_review
717
+ AUTHOR_BLOCK = :author_block
718
+ DRY_RUN = :dry_run
719
+
720
+ # @!method self.values
721
+ # @return [Array<Symbol>]
722
+ end
723
+ end
724
+
725
+ class Error < ModerationAPI::Internal::Type::BaseModel
726
+ # @!attribute id
727
+ #
728
+ # @return [String]
729
+ required :id, String
730
+
731
+ # @!attribute message
732
+ #
733
+ # @return [String]
734
+ required :message, String
735
+
736
+ # @!method initialize(id:, message:)
737
+ # @param id [String]
738
+ # @param message [String]
739
+ end
740
+ end
741
+ end
742
+ end