moderation_api 1.2.0 → 1.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (176) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +87 -0
  3. data/README.md +61 -106
  4. data/docs/AccountApi.md +5 -5
  5. data/docs/AccountGet200Response.md +2 -2
  6. data/docs/AccountGet200ResponseCurrentProject.md +2 -2
  7. data/docs/ActionsCreateRequest.md +2 -2
  8. data/docs/ActionsCreateRequestWebhooksInner.md +2 -2
  9. data/docs/ActionsDelete200Response.md +2 -2
  10. data/docs/ActionsExecute200Response.md +2 -2
  11. data/docs/ActionsExecuteDeprecatedRequest.md +2 -2
  12. data/docs/ActionsExecuteRequest.md +2 -2
  13. data/docs/ActionsGet200Response.md +2 -2
  14. data/docs/ActionsGet200ResponseWebhooksInner.md +2 -2
  15. data/docs/ActionsList200ResponseInner.md +2 -2
  16. data/docs/ActionsList200ResponseInnerPossibleValuesInner.md +2 -2
  17. data/docs/ActionsList400Response.md +2 -2
  18. data/docs/ActionsList400ResponseIssuesInner.md +2 -2
  19. data/docs/ActionsUpdateRequest.md +2 -2
  20. data/docs/ModerateApi.md +26 -26
  21. data/docs/ModerationAudioRequest.md +2 -2
  22. data/docs/ModerationImage200Response.md +2 -2
  23. data/docs/ModerationImage200ResponseLabelsInner.md +2 -2
  24. data/docs/ModerationImageRequest.md +2 -2
  25. data/docs/ModerationObject200Response.md +2 -2
  26. data/docs/ModerationObject200ResponseAllOfEntitiesInner.md +2 -2
  27. data/docs/ModerationObject200ResponseAllOfFieldsInner.md +2 -2
  28. data/docs/ModerationObject200ResponseAllOfLabelsInner.md +2 -2
  29. data/docs/ModerationObjectRequest.md +2 -2
  30. data/docs/ModerationObjectRequestValue.md +2 -2
  31. data/docs/ModerationObjectRequestValueDataValue.md +2 -2
  32. data/docs/ModerationText200Response.md +2 -2
  33. data/docs/ModerationText200ResponseAllOfAddress.md +2 -2
  34. data/docs/ModerationText200ResponseAllOfEmail.md +2 -2
  35. data/docs/ModerationText200ResponseAllOfName.md +2 -2
  36. data/docs/ModerationText200ResponseAllOfNsfw.md +2 -2
  37. data/docs/ModerationText200ResponseAllOfNsfwLabelScores.md +2 -2
  38. data/docs/ModerationText200ResponseAllOfPhone.md +2 -2
  39. data/docs/ModerationText200ResponseAllOfProfanity.md +2 -2
  40. data/docs/ModerationText200ResponseAllOfPropriety.md +2 -2
  41. data/docs/ModerationText200ResponseAllOfProprietyLabelScores.md +2 -2
  42. data/docs/ModerationText200ResponseAllOfQuality.md +2 -2
  43. data/docs/ModerationText200ResponseAllOfQualityLabelScores.md +2 -2
  44. data/docs/ModerationText200ResponseAllOfRequest.md +2 -2
  45. data/docs/ModerationText200ResponseAllOfSensitive.md +2 -2
  46. data/docs/ModerationText200ResponseAllOfSentiment.md +2 -2
  47. data/docs/ModerationText200ResponseAllOfSentimentLabelScores.md +2 -2
  48. data/docs/ModerationText200ResponseAllOfToxicity.md +2 -2
  49. data/docs/ModerationText200ResponseAllOfToxicityLabelScores.md +2 -2
  50. data/docs/ModerationText200ResponseAllOfUrl.md +2 -2
  51. data/docs/ModerationText200ResponseAllOfUsername.md +2 -2
  52. data/docs/ModerationText200ResponseAllOfWordlist.md +2 -2
  53. data/docs/ModerationText200ResponseAllOfWordlistsInner.md +2 -2
  54. data/docs/ModerationTextRequest.md +2 -2
  55. data/docs/ModerationVideo200Response.md +2 -2
  56. data/docs/ModerationVideoRequest.md +2 -2
  57. data/docs/QueueActionsApi.md +33 -33
  58. data/lib/moderation_api/api/account_api.rb +1 -1
  59. data/lib/moderation_api/api/moderate_api.rb +1 -1
  60. data/lib/moderation_api/api/queue_actions_api.rb +1 -1
  61. data/lib/moderation_api/api_client.rb +2 -2
  62. data/lib/moderation_api/api_error.rb +1 -1
  63. data/lib/moderation_api/configuration.rb +1 -1
  64. data/lib/moderation_api/models/account_get200_response.rb +4 -4
  65. data/lib/moderation_api/models/account_get200_response_current_project.rb +4 -4
  66. data/lib/moderation_api/models/actions_create_request.rb +4 -4
  67. data/lib/moderation_api/models/actions_create_request_webhooks_inner.rb +4 -4
  68. data/lib/moderation_api/models/actions_delete200_response.rb +4 -4
  69. data/lib/moderation_api/models/actions_execute200_response.rb +4 -4
  70. data/lib/moderation_api/models/actions_execute_deprecated_request.rb +4 -4
  71. data/lib/moderation_api/models/actions_execute_request.rb +4 -4
  72. data/lib/moderation_api/models/actions_get200_response.rb +4 -4
  73. data/lib/moderation_api/models/actions_get200_response_webhooks_inner.rb +4 -4
  74. data/lib/moderation_api/models/actions_list200_response_inner.rb +4 -4
  75. data/lib/moderation_api/models/actions_list200_response_inner_possible_values_inner.rb +4 -4
  76. data/lib/moderation_api/models/actions_list400_response.rb +4 -4
  77. data/lib/moderation_api/models/actions_list400_response_issues_inner.rb +4 -4
  78. data/lib/moderation_api/models/actions_update_request.rb +4 -4
  79. data/lib/moderation_api/models/moderation_audio_request.rb +4 -4
  80. data/lib/moderation_api/models/moderation_image200_response.rb +4 -4
  81. data/lib/moderation_api/models/moderation_image200_response_labels_inner.rb +4 -4
  82. data/lib/moderation_api/models/moderation_image_request.rb +4 -4
  83. data/lib/moderation_api/models/moderation_object200_response.rb +4 -4
  84. data/lib/moderation_api/models/moderation_object200_response_all_of_entities_inner.rb +4 -4
  85. data/lib/moderation_api/models/moderation_object200_response_all_of_fields_inner.rb +4 -4
  86. data/lib/moderation_api/models/moderation_object200_response_all_of_labels_inner.rb +4 -4
  87. data/lib/moderation_api/models/moderation_object_request.rb +4 -4
  88. data/lib/moderation_api/models/moderation_object_request_value.rb +4 -4
  89. data/lib/moderation_api/models/moderation_object_request_value_data_value.rb +4 -4
  90. data/lib/moderation_api/models/moderation_text200_response.rb +4 -4
  91. data/lib/moderation_api/models/moderation_text200_response_all_of_address.rb +4 -4
  92. data/lib/moderation_api/models/moderation_text200_response_all_of_email.rb +4 -4
  93. data/lib/moderation_api/models/moderation_text200_response_all_of_name.rb +4 -4
  94. data/lib/moderation_api/models/moderation_text200_response_all_of_nsfw.rb +4 -4
  95. data/lib/moderation_api/models/moderation_text200_response_all_of_nsfw_label_scores.rb +4 -4
  96. data/lib/moderation_api/models/moderation_text200_response_all_of_phone.rb +4 -4
  97. data/lib/moderation_api/models/moderation_text200_response_all_of_profanity.rb +4 -4
  98. data/lib/moderation_api/models/moderation_text200_response_all_of_propriety.rb +4 -4
  99. data/lib/moderation_api/models/moderation_text200_response_all_of_propriety_label_scores.rb +4 -4
  100. data/lib/moderation_api/models/moderation_text200_response_all_of_quality.rb +4 -4
  101. data/lib/moderation_api/models/moderation_text200_response_all_of_quality_label_scores.rb +4 -4
  102. data/lib/moderation_api/models/moderation_text200_response_all_of_request.rb +4 -4
  103. data/lib/moderation_api/models/moderation_text200_response_all_of_sensitive.rb +4 -4
  104. data/lib/moderation_api/models/moderation_text200_response_all_of_sentiment.rb +4 -4
  105. data/lib/moderation_api/models/moderation_text200_response_all_of_sentiment_label_scores.rb +4 -4
  106. data/lib/moderation_api/models/moderation_text200_response_all_of_toxicity.rb +4 -4
  107. data/lib/moderation_api/models/moderation_text200_response_all_of_toxicity_label_scores.rb +4 -4
  108. data/lib/moderation_api/models/moderation_text200_response_all_of_url.rb +4 -4
  109. data/lib/moderation_api/models/moderation_text200_response_all_of_username.rb +4 -4
  110. data/lib/moderation_api/models/moderation_text200_response_all_of_wordlist.rb +4 -4
  111. data/lib/moderation_api/models/moderation_text200_response_all_of_wordlists_inner.rb +4 -4
  112. data/lib/moderation_api/models/moderation_text_request.rb +4 -4
  113. data/lib/moderation_api/models/moderation_video200_response.rb +4 -4
  114. data/lib/moderation_api/models/moderation_video_request.rb +4 -4
  115. data/lib/moderation_api/version.rb +2 -2
  116. data/lib/moderation_api/webhook.rb +41 -0
  117. data/lib/moderation_api.rb +56 -56
  118. data/moderation_api-1.2.0.gem +0 -0
  119. data/moderation_api-1.2.1.gem +0 -0
  120. data/moderation_api.gemspec +3 -3
  121. data/ruby_config.yaml +30 -0
  122. data/spec/api/account_api_spec.rb +3 -3
  123. data/spec/api/moderate_api_spec.rb +3 -3
  124. data/spec/api/queue_actions_api_spec.rb +3 -3
  125. data/spec/models/account_get200_response_current_project_spec.rb +4 -4
  126. data/spec/models/account_get200_response_spec.rb +4 -4
  127. data/spec/models/actions_create_request_spec.rb +4 -4
  128. data/spec/models/actions_create_request_webhooks_inner_spec.rb +4 -4
  129. data/spec/models/actions_delete200_response_spec.rb +4 -4
  130. data/spec/models/actions_execute200_response_spec.rb +4 -4
  131. data/spec/models/actions_execute_deprecated_request_spec.rb +4 -4
  132. data/spec/models/actions_execute_request_spec.rb +4 -4
  133. data/spec/models/actions_get200_response_spec.rb +4 -4
  134. data/spec/models/actions_get200_response_webhooks_inner_spec.rb +4 -4
  135. data/spec/models/actions_list200_response_inner_possible_values_inner_spec.rb +4 -4
  136. data/spec/models/actions_list200_response_inner_spec.rb +4 -4
  137. data/spec/models/actions_list400_response_issues_inner_spec.rb +4 -4
  138. data/spec/models/actions_list400_response_spec.rb +4 -4
  139. data/spec/models/actions_update_request_spec.rb +4 -4
  140. data/spec/models/moderation_audio_request_spec.rb +4 -4
  141. data/spec/models/moderation_image200_response_labels_inner_spec.rb +4 -4
  142. data/spec/models/moderation_image200_response_spec.rb +4 -4
  143. data/spec/models/moderation_image_request_spec.rb +4 -4
  144. data/spec/models/moderation_object200_response_all_of_entities_inner_spec.rb +4 -4
  145. data/spec/models/moderation_object200_response_all_of_fields_inner_spec.rb +4 -4
  146. data/spec/models/moderation_object200_response_all_of_labels_inner_spec.rb +4 -4
  147. data/spec/models/moderation_object200_response_spec.rb +4 -4
  148. data/spec/models/moderation_object_request_spec.rb +4 -4
  149. data/spec/models/moderation_object_request_value_data_value_spec.rb +4 -4
  150. data/spec/models/moderation_object_request_value_spec.rb +4 -4
  151. data/spec/models/moderation_text200_response_all_of_address_spec.rb +4 -4
  152. data/spec/models/moderation_text200_response_all_of_email_spec.rb +4 -4
  153. data/spec/models/moderation_text200_response_all_of_name_spec.rb +4 -4
  154. data/spec/models/moderation_text200_response_all_of_nsfw_label_scores_spec.rb +4 -4
  155. data/spec/models/moderation_text200_response_all_of_nsfw_spec.rb +4 -4
  156. data/spec/models/moderation_text200_response_all_of_phone_spec.rb +4 -4
  157. data/spec/models/moderation_text200_response_all_of_profanity_spec.rb +4 -4
  158. data/spec/models/moderation_text200_response_all_of_propriety_label_scores_spec.rb +4 -4
  159. data/spec/models/moderation_text200_response_all_of_propriety_spec.rb +4 -4
  160. data/spec/models/moderation_text200_response_all_of_quality_label_scores_spec.rb +4 -4
  161. data/spec/models/moderation_text200_response_all_of_quality_spec.rb +4 -4
  162. data/spec/models/moderation_text200_response_all_of_request_spec.rb +4 -4
  163. data/spec/models/moderation_text200_response_all_of_sensitive_spec.rb +4 -4
  164. data/spec/models/moderation_text200_response_all_of_sentiment_label_scores_spec.rb +4 -4
  165. data/spec/models/moderation_text200_response_all_of_sentiment_spec.rb +4 -4
  166. data/spec/models/moderation_text200_response_all_of_toxicity_label_scores_spec.rb +4 -4
  167. data/spec/models/moderation_text200_response_all_of_toxicity_spec.rb +4 -4
  168. data/spec/models/moderation_text200_response_all_of_url_spec.rb +4 -4
  169. data/spec/models/moderation_text200_response_all_of_username_spec.rb +4 -4
  170. data/spec/models/moderation_text200_response_all_of_wordlist_spec.rb +4 -4
  171. data/spec/models/moderation_text200_response_all_of_wordlists_inner_spec.rb +4 -4
  172. data/spec/models/moderation_text200_response_spec.rb +4 -4
  173. data/spec/models/moderation_text_request_spec.rb +4 -4
  174. data/spec/models/moderation_video200_response_spec.rb +4 -4
  175. data/spec/models/moderation_video_request_spec.rb +4 -4
  176. metadata +9 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 01b054414c274bbd8477a7eb3119f1590d1ef83474500cdfd7cd2d52ee1ff069
4
- data.tar.gz: fc294ed0ba8cf33972dda43dd359a2ff25eb8bfb5bba8d3b438563411c8d3ffb
3
+ metadata.gz: 12e29ae7110131a4a7699d95b2e6270236650c6c61456ddc8d3818947aed8115
4
+ data.tar.gz: 65b580b31b50dcc68b0373b586be940c48807352b06e9b536405778fbae4a67d
5
5
  SHA512:
6
- metadata.gz: 2a72621a0abbc91d8bd61c51a1afeaf0b9e64b0fda84f137ab7a1afd4aa7fc553b8dd548b921da4f9117f3b2e0150c5bdd2e72a5cbfe68c22f1b4cd29dfadc83
7
- data.tar.gz: c5f8f6268af67cfb9bf208d32e34aad785a515e8d063f31d5550f47602ec4a8b711f6d8701f80905733dcc32cf580de5a878f96edb1c5336d54f1dbe5f96e61b
6
+ metadata.gz: 94531d1b4beb1a93012524b256c9525b5f7710634973544d2c534f5532a6049d30fc177faee1838a2cf2b7ce95ed51c23faf39a7426ed347f37b143fa1936027
7
+ data.tar.gz: e08851ca8ce76353c4078c56c37669e1a39c9bdf3300c7cd1e3dfa911340cc6619f1cac8a21b015b51510eef8a254a1f70afdc459c0bf35ca4387e60229446ad
data/Gemfile.lock ADDED
@@ -0,0 +1,87 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ moderation_api (1.2.2)
5
+ faraday (>= 1.0.1, < 3.0)
6
+ faraday-multipart
7
+ marcel
8
+
9
+ GEM
10
+ remote: https://rubygems.org/
11
+ specs:
12
+ ast (2.4.2)
13
+ byebug (11.1.3)
14
+ coderay (1.1.3)
15
+ date (3.4.1)
16
+ diff-lcs (1.5.1)
17
+ faraday (2.12.2)
18
+ faraday-net_http (>= 2.0, < 3.5)
19
+ json
20
+ logger
21
+ faraday-multipart (1.1.0)
22
+ multipart-post (~> 2.0)
23
+ faraday-net_http (3.4.0)
24
+ net-http (>= 0.5.0)
25
+ jaro_winkler (1.5.6)
26
+ json (2.9.1)
27
+ logger (1.6.4)
28
+ marcel (1.0.4)
29
+ method_source (1.1.0)
30
+ multipart-post (2.4.1)
31
+ net-http (0.6.0)
32
+ uri
33
+ parallel (1.26.3)
34
+ parser (3.3.6.0)
35
+ ast (~> 2.4.1)
36
+ racc
37
+ pry (0.14.2)
38
+ coderay (~> 1.1)
39
+ method_source (~> 1.0)
40
+ pry-byebug (3.10.1)
41
+ byebug (~> 11.0)
42
+ pry (>= 0.13, < 0.15)
43
+ psych (5.2.2)
44
+ date
45
+ stringio
46
+ racc (1.8.1)
47
+ rainbow (3.1.1)
48
+ rake (13.0.6)
49
+ rspec (3.13.0)
50
+ rspec-core (~> 3.13.0)
51
+ rspec-expectations (~> 3.13.0)
52
+ rspec-mocks (~> 3.13.0)
53
+ rspec-core (3.13.2)
54
+ rspec-support (~> 3.13.0)
55
+ rspec-expectations (3.13.3)
56
+ diff-lcs (>= 1.2.0, < 2.0)
57
+ rspec-support (~> 3.13.0)
58
+ rspec-mocks (3.13.2)
59
+ diff-lcs (>= 1.2.0, < 2.0)
60
+ rspec-support (~> 3.13.0)
61
+ rspec-support (3.13.2)
62
+ rubocop (0.66.0)
63
+ jaro_winkler (~> 1.5.1)
64
+ parallel (~> 1.10)
65
+ parser (>= 2.5, != 2.5.1.1)
66
+ psych (>= 3.1.0)
67
+ rainbow (>= 2.2.2, < 4.0)
68
+ ruby-progressbar (~> 1.7)
69
+ unicode-display_width (>= 1.4.0, < 1.6)
70
+ ruby-progressbar (1.13.0)
71
+ stringio (3.1.2)
72
+ unicode-display_width (1.5.0)
73
+ uri (1.0.2)
74
+
75
+ PLATFORMS
76
+ ruby
77
+ x86_64-darwin-24
78
+
79
+ DEPENDENCIES
80
+ moderation_api!
81
+ pry-byebug
82
+ rake (~> 13.0.1)
83
+ rspec (~> 3.6, >= 3.6.0)
84
+ rubocop (~> 0.66.0)
85
+
86
+ BUNDLED WITH
87
+ 2.6.2
data/README.md CHANGED
@@ -1,15 +1,12 @@
1
- # moderation_api
1
+ # Moderation API Ruby library
2
2
 
3
- ModerationAPI - the Ruby gem for the Moderation API
3
+ The Moderation API Ruby library provides convenient access to the Moderation API from applications written in Ruby.
4
4
 
5
- API for automated content moderation
5
+ Use the Moderation API to analyze text and images for offensive content, profanity, toxicity, discrimination, sentiment, language and more - or detect, hide, and extract data entities like emails, phone numbers, addresses and more.
6
6
 
7
- This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
7
+ ## Documentation
8
8
 
9
- - API version: 1.0.0
10
- - Package version: 1.2.0
11
- - Generator version: 7.10.0
12
- - Build package: org.openapitools.codegen.languages.RubyClientCodegen
9
+ See the [Moderation API docs](https://docs.moderationapi.com) for Ruby.
13
10
 
14
11
  ## Installation
15
12
 
@@ -31,114 +28,72 @@ Or install it yourself as:
31
28
  gem install moderation_api
32
29
  ```
33
30
 
34
- ## Getting Started
31
+ ## Usage
35
32
 
36
- Please follow the [installation](#installation) procedure and then run the following code:
33
+ The package needs to be configured with your project's API key, which is
34
+ available in your [Project Dashboard](https://moderationapi.com/app/projects). Configure the client with your key:
37
35
 
38
36
  ```ruby
39
- # Load the gem
40
37
  require 'moderation_api'
41
38
 
42
- # Setup authorization
43
- ModerationAPI.configure do |config|
44
- # Configure Bearer authorization: Authorization
45
- config.access_token = 'YOUR_BEARER_TOKEN'
46
- # Configure a proc to get access tokens in lieu of the static access_token configuration
47
- config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' }
48
- # Configure faraday connection
49
- config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
39
+ ModerationApi.configure do |config|
40
+ config.access_token = 'proj_...'
50
41
  end
51
42
 
52
- api_instance = ModerationAPI::AccountApi.new
43
+ api = ModerationApi::ModerateApi.new
53
44
 
54
45
  begin
55
- #Get account details
56
- result = api_instance.account_get
57
- p result
58
- rescue ModerationAPI::ApiError => e
59
- puts "Exception when calling AccountApi->account_get: #{e}"
46
+ analysis = api.moderation_text({value: 'Hello world!'})
47
+ puts analysis.flagged
48
+ rescue ModerationApi::ApiError => e
49
+ puts "Error: #{e}"
60
50
  end
51
+ ```
52
+
53
+ ### Webhook signing
54
+
55
+ Moderation API can optionally sign the webhook events it sends to your endpoint, allowing you to validate that they were not sent by a third-party. You can read more about it [here](https://docs.moderationapi.com/review-queues/webhooks).
61
56
 
57
+ Here's an example using Rails:
58
+
59
+ ```ruby
60
+ class WebhooksController < ApplicationController
61
+ skip_before_action :verify_authenticity_token
62
+
63
+ def create
64
+ payload = request.body.read
65
+ sig_header = request.env['HTTP_MODAPI_SIGNATURE']
66
+
67
+ begin
68
+ event_data = ModerationApi::Webhook.construct_event(
69
+ payload, sig_header, ENV['MODAPI_WEBHOOK_SECRET']
70
+ )
71
+ rescue JSON::ParserError => e
72
+ return render plain: "Invalid payload: #{e}", status: 400
73
+ rescue ModerationApi::Webhook::SignatureVerificationError => e
74
+ return render plain: "Invalid signature: #{e}", status: 400
75
+ end
76
+
77
+ # Handle the event
78
+ puts "Webhook received! #{event_data[:type]}"
79
+
80
+ head :ok
81
+ end
82
+ end
62
83
  ```
63
84
 
64
- ## Documentation for API Endpoints
65
-
66
- All URIs are relative to *https://moderationapi.com/api/v1*
67
-
68
- | Class | Method | HTTP request | Description |
69
- | -------------------------------- | ------------------------------------------------------------------------------------ | ------------------------------------ | ------------------- |
70
- | _ModerationAPI::AccountApi_ | [**account_get**](docs/AccountApi.md#account_get) | **GET** /account | Get account details |
71
- | _ModerationAPI::ModerateApi_ | [**moderation_audio**](docs/ModerateApi.md#moderation_audio) | **POST** /moderate/audio | Analyze audio |
72
- | _ModerationAPI::ModerateApi_ | [**moderation_image**](docs/ModerateApi.md#moderation_image) | **POST** /moderate/image | Analyze image |
73
- | _ModerationAPI::ModerateApi_ | [**moderation_object**](docs/ModerateApi.md#moderation_object) | **POST** /moderate/object | Analyze object. |
74
- | _ModerationAPI::ModerateApi_ | [**moderation_text**](docs/ModerateApi.md#moderation_text) | **POST** /moderate/text | Analyze text. |
75
- | _ModerationAPI::ModerateApi_ | [**moderation_video**](docs/ModerateApi.md#moderation_video) | **POST** /moderate/video | Analyze video |
76
- | _ModerationAPI::QueueActionsApi_ | [**actions_create**](docs/QueueActionsApi.md#actions_create) | **POST** /actions | Create an action |
77
- | _ModerationAPI::QueueActionsApi_ | [**actions_delete**](docs/QueueActionsApi.md#actions_delete) | **DELETE** /actions/{id} | Delete an action |
78
- | _ModerationAPI::QueueActionsApi_ | [**actions_execute**](docs/QueueActionsApi.md#actions_execute) | **POST** /actions/execute | Execute an action |
79
- | _ModerationAPI::QueueActionsApi_ | [**actions_execute_deprecated**](docs/QueueActionsApi.md#actions_execute_deprecated) | **POST** /actions/{actionId}/execute | Execute an action |
80
- | _ModerationAPI::QueueActionsApi_ | [**actions_get**](docs/QueueActionsApi.md#actions_get) | **GET** /actions/{id} | Get an action |
81
- | _ModerationAPI::QueueActionsApi_ | [**actions_list**](docs/QueueActionsApi.md#actions_list) | **GET** /actions | List actions |
82
- | _ModerationAPI::QueueActionsApi_ | [**actions_update**](docs/QueueActionsApi.md#actions_update) | **PUT** /actions/{id} | Update an action |
83
-
84
- ## Documentation for Models
85
-
86
- - [ModerationAPI::AccountGet200Response](docs/AccountGet200Response.md)
87
- - [ModerationAPI::AccountGet200ResponseCurrentProject](docs/AccountGet200ResponseCurrentProject.md)
88
- - [ModerationAPI::ActionsCreateRequest](docs/ActionsCreateRequest.md)
89
- - [ModerationAPI::ActionsCreateRequestWebhooksInner](docs/ActionsCreateRequestWebhooksInner.md)
90
- - [ModerationAPI::ActionsDelete200Response](docs/ActionsDelete200Response.md)
91
- - [ModerationAPI::ActionsExecute200Response](docs/ActionsExecute200Response.md)
92
- - [ModerationAPI::ActionsExecuteDeprecatedRequest](docs/ActionsExecuteDeprecatedRequest.md)
93
- - [ModerationAPI::ActionsExecuteRequest](docs/ActionsExecuteRequest.md)
94
- - [ModerationAPI::ActionsGet200Response](docs/ActionsGet200Response.md)
95
- - [ModerationAPI::ActionsGet200ResponseWebhooksInner](docs/ActionsGet200ResponseWebhooksInner.md)
96
- - [ModerationAPI::ActionsList200ResponseInner](docs/ActionsList200ResponseInner.md)
97
- - [ModerationAPI::ActionsList200ResponseInnerPossibleValuesInner](docs/ActionsList200ResponseInnerPossibleValuesInner.md)
98
- - [ModerationAPI::ActionsList400Response](docs/ActionsList400Response.md)
99
- - [ModerationAPI::ActionsList400ResponseIssuesInner](docs/ActionsList400ResponseIssuesInner.md)
100
- - [ModerationAPI::ActionsUpdateRequest](docs/ActionsUpdateRequest.md)
101
- - [ModerationAPI::ModerationAudioRequest](docs/ModerationAudioRequest.md)
102
- - [ModerationAPI::ModerationImage200Response](docs/ModerationImage200Response.md)
103
- - [ModerationAPI::ModerationImage200ResponseLabelsInner](docs/ModerationImage200ResponseLabelsInner.md)
104
- - [ModerationAPI::ModerationImageRequest](docs/ModerationImageRequest.md)
105
- - [ModerationAPI::ModerationObject200Response](docs/ModerationObject200Response.md)
106
- - [ModerationAPI::ModerationObject200ResponseAllOfEntitiesInner](docs/ModerationObject200ResponseAllOfEntitiesInner.md)
107
- - [ModerationAPI::ModerationObject200ResponseAllOfFieldsInner](docs/ModerationObject200ResponseAllOfFieldsInner.md)
108
- - [ModerationAPI::ModerationObject200ResponseAllOfLabelsInner](docs/ModerationObject200ResponseAllOfLabelsInner.md)
109
- - [ModerationAPI::ModerationObjectRequest](docs/ModerationObjectRequest.md)
110
- - [ModerationAPI::ModerationObjectRequestValue](docs/ModerationObjectRequestValue.md)
111
- - [ModerationAPI::ModerationObjectRequestValueDataValue](docs/ModerationObjectRequestValueDataValue.md)
112
- - [ModerationAPI::ModerationText200Response](docs/ModerationText200Response.md)
113
- - [ModerationAPI::ModerationText200ResponseAllOfAddress](docs/ModerationText200ResponseAllOfAddress.md)
114
- - [ModerationAPI::ModerationText200ResponseAllOfEmail](docs/ModerationText200ResponseAllOfEmail.md)
115
- - [ModerationAPI::ModerationText200ResponseAllOfName](docs/ModerationText200ResponseAllOfName.md)
116
- - [ModerationAPI::ModerationText200ResponseAllOfNsfw](docs/ModerationText200ResponseAllOfNsfw.md)
117
- - [ModerationAPI::ModerationText200ResponseAllOfNsfwLabelScores](docs/ModerationText200ResponseAllOfNsfwLabelScores.md)
118
- - [ModerationAPI::ModerationText200ResponseAllOfPhone](docs/ModerationText200ResponseAllOfPhone.md)
119
- - [ModerationAPI::ModerationText200ResponseAllOfProfanity](docs/ModerationText200ResponseAllOfProfanity.md)
120
- - [ModerationAPI::ModerationText200ResponseAllOfPropriety](docs/ModerationText200ResponseAllOfPropriety.md)
121
- - [ModerationAPI::ModerationText200ResponseAllOfProprietyLabelScores](docs/ModerationText200ResponseAllOfProprietyLabelScores.md)
122
- - [ModerationAPI::ModerationText200ResponseAllOfQuality](docs/ModerationText200ResponseAllOfQuality.md)
123
- - [ModerationAPI::ModerationText200ResponseAllOfQualityLabelScores](docs/ModerationText200ResponseAllOfQualityLabelScores.md)
124
- - [ModerationAPI::ModerationText200ResponseAllOfRequest](docs/ModerationText200ResponseAllOfRequest.md)
125
- - [ModerationAPI::ModerationText200ResponseAllOfSensitive](docs/ModerationText200ResponseAllOfSensitive.md)
126
- - [ModerationAPI::ModerationText200ResponseAllOfSentiment](docs/ModerationText200ResponseAllOfSentiment.md)
127
- - [ModerationAPI::ModerationText200ResponseAllOfSentimentLabelScores](docs/ModerationText200ResponseAllOfSentimentLabelScores.md)
128
- - [ModerationAPI::ModerationText200ResponseAllOfToxicity](docs/ModerationText200ResponseAllOfToxicity.md)
129
- - [ModerationAPI::ModerationText200ResponseAllOfToxicityLabelScores](docs/ModerationText200ResponseAllOfToxicityLabelScores.md)
130
- - [ModerationAPI::ModerationText200ResponseAllOfUrl](docs/ModerationText200ResponseAllOfUrl.md)
131
- - [ModerationAPI::ModerationText200ResponseAllOfUsername](docs/ModerationText200ResponseAllOfUsername.md)
132
- - [ModerationAPI::ModerationText200ResponseAllOfWordlist](docs/ModerationText200ResponseAllOfWordlist.md)
133
- - [ModerationAPI::ModerationText200ResponseAllOfWordlistsInner](docs/ModerationText200ResponseAllOfWordlistsInner.md)
134
- - [ModerationAPI::ModerationTextRequest](docs/ModerationTextRequest.md)
135
- - [ModerationAPI::ModerationVideo200Response](docs/ModerationVideo200Response.md)
136
- - [ModerationAPI::ModerationVideoRequest](docs/ModerationVideoRequest.md)
137
-
138
- ## Documentation for Authorization
139
-
140
- Authentication schemes defined for the API:
141
-
142
- ### Authorization
143
-
144
- - **Type**: Bearer authentication
85
+ ## Support
86
+
87
+ New features and bug fixes are released on the latest major version of the `moderation_api` gem. If you are on an older major version, we recommend that you upgrade to the latest in order to use the new features and bug fixes including those for security vulnerabilities. Older major versions of the package will continue to be available for use, but will not be receiving any updates.
88
+
89
+ ## Email support
90
+
91
+ Reach out at [support@moderationapi.com](mailto:support@moderationapi.com)
92
+
93
+ ## More Information
94
+
95
+ - [REST API Reference](https://docs.moderationapi.com/api-reference/introduction)
96
+ - [Rate limits](https://docs.moderationapi.com/api-reference/rate-limits)
97
+ - [Error Handling](https://docs.moderationapi.com/api-reference/errors)
98
+ - [Documentation](https://docs.moderationapi.com/get-started/introduction)
99
+ - [Test your API key](https://docs.moderationapi.com/api-reference/authentication)
data/docs/AccountApi.md CHANGED
@@ -1,4 +1,4 @@
1
- # ModerationAPI::AccountApi
1
+ # ModerationApi::AccountApi
2
2
 
3
3
  All URIs are relative to *https://moderationapi.com/api/v1*
4
4
 
@@ -21,18 +21,18 @@ Get account details
21
21
  require 'time'
22
22
  require 'moderation_api'
23
23
  # setup authorization
24
- ModerationAPI.configure do |config|
24
+ ModerationApi.configure do |config|
25
25
  # Configure Bearer authorization: Authorization
26
26
  config.access_token = 'YOUR_BEARER_TOKEN'
27
27
  end
28
28
 
29
- api_instance = ModerationAPI::AccountApi.new
29
+ api_instance = ModerationApi::AccountApi.new
30
30
 
31
31
  begin
32
32
  # Get account details
33
33
  result = api_instance.account_get
34
34
  p result
35
- rescue ModerationAPI::ApiError => e
35
+ rescue ModerationApi::ApiError => e
36
36
  puts "Error when calling AccountApi->account_get: #{e}"
37
37
  end
38
38
  ```
@@ -50,7 +50,7 @@ begin
50
50
  p status_code # => 2xx
51
51
  p headers # => { ... }
52
52
  p data # => <AccountGet200Response>
53
- rescue ModerationAPI::ApiError => e
53
+ rescue ModerationApi::ApiError => e
54
54
  puts "Error when calling AccountApi->account_get_with_http_info: #{e}"
55
55
  end
56
56
  ```
@@ -1,4 +1,4 @@
1
- # ModerationAPI::AccountGet200Response
1
+ # ModerationApi::AccountGet200Response
2
2
 
3
3
  ## Properties
4
4
 
@@ -15,7 +15,7 @@
15
15
  ```ruby
16
16
  require 'moderation_api'
17
17
 
18
- instance = ModerationAPI::AccountGet200Response.new(
18
+ instance = ModerationApi::AccountGet200Response.new(
19
19
  id: null,
20
20
  paid_plan_name: null,
21
21
  text_api_quota: null,
@@ -1,4 +1,4 @@
1
- # ModerationAPI::AccountGet200ResponseCurrentProject
1
+ # ModerationApi::AccountGet200ResponseCurrentProject
2
2
 
3
3
  ## Properties
4
4
 
@@ -12,7 +12,7 @@
12
12
  ```ruby
13
13
  require 'moderation_api'
14
14
 
15
- instance = ModerationAPI::AccountGet200ResponseCurrentProject.new(
15
+ instance = ModerationApi::AccountGet200ResponseCurrentProject.new(
16
16
  id: null,
17
17
  name: null
18
18
  )
@@ -1,4 +1,4 @@
1
- # ModerationAPI::ActionsCreateRequest
1
+ # ModerationApi::ActionsCreateRequest
2
2
 
3
3
  ## Properties
4
4
 
@@ -20,7 +20,7 @@
20
20
  ```ruby
21
21
  require 'moderation_api'
22
22
 
23
- instance = ModerationAPI::ActionsCreateRequest.new(
23
+ instance = ModerationApi::ActionsCreateRequest.new(
24
24
  name: null,
25
25
  key: null,
26
26
  description: null,
@@ -1,4 +1,4 @@
1
- # ModerationAPI::ActionsCreateRequestWebhooksInner
1
+ # ModerationApi::ActionsCreateRequestWebhooksInner
2
2
 
3
3
  ## Properties
4
4
 
@@ -14,7 +14,7 @@
14
14
  ```ruby
15
15
  require 'moderation_api'
16
16
 
17
- instance = ModerationAPI::ActionsCreateRequestWebhooksInner.new(
17
+ instance = ModerationApi::ActionsCreateRequestWebhooksInner.new(
18
18
  name: null,
19
19
  url: null,
20
20
  description: null,
@@ -1,4 +1,4 @@
1
- # ModerationAPI::ActionsDelete200Response
1
+ # ModerationApi::ActionsDelete200Response
2
2
 
3
3
  ## Properties
4
4
 
@@ -12,7 +12,7 @@
12
12
  ```ruby
13
13
  require 'moderation_api'
14
14
 
15
- instance = ModerationAPI::ActionsDelete200Response.new(
15
+ instance = ModerationApi::ActionsDelete200Response.new(
16
16
  deleted: null,
17
17
  id: null
18
18
  )
@@ -1,4 +1,4 @@
1
- # ModerationAPI::ActionsExecute200Response
1
+ # ModerationApi::ActionsExecute200Response
2
2
 
3
3
  ## Properties
4
4
 
@@ -13,7 +13,7 @@
13
13
  ```ruby
14
14
  require 'moderation_api'
15
15
 
16
- instance = ModerationAPI::ActionsExecute200Response.new(
16
+ instance = ModerationApi::ActionsExecute200Response.new(
17
17
  success: null,
18
18
  action_id: null,
19
19
  ids: null
@@ -1,4 +1,4 @@
1
- # ModerationAPI::ActionsExecuteDeprecatedRequest
1
+ # ModerationApi::ActionsExecuteDeprecatedRequest
2
2
 
3
3
  ## Properties
4
4
 
@@ -13,7 +13,7 @@
13
13
  ```ruby
14
14
  require 'moderation_api'
15
15
 
16
- instance = ModerationAPI::ActionsExecuteDeprecatedRequest.new(
16
+ instance = ModerationApi::ActionsExecuteDeprecatedRequest.new(
17
17
  content_ids: null,
18
18
  queue_id: null,
19
19
  value: null
@@ -1,4 +1,4 @@
1
- # ModerationAPI::ActionsExecuteRequest
1
+ # ModerationApi::ActionsExecuteRequest
2
2
 
3
3
  ## Properties
4
4
 
@@ -14,7 +14,7 @@
14
14
  ```ruby
15
15
  require 'moderation_api'
16
16
 
17
- instance = ModerationAPI::ActionsExecuteRequest.new(
17
+ instance = ModerationApi::ActionsExecuteRequest.new(
18
18
  content_ids: null,
19
19
  action_id: null,
20
20
  queue_id: null,
@@ -1,4 +1,4 @@
1
- # ModerationAPI::ActionsGet200Response
1
+ # ModerationApi::ActionsGet200Response
2
2
 
3
3
  ## Properties
4
4
 
@@ -22,7 +22,7 @@
22
22
  ```ruby
23
23
  require 'moderation_api'
24
24
 
25
- instance = ModerationAPI::ActionsGet200Response.new(
25
+ instance = ModerationApi::ActionsGet200Response.new(
26
26
  id: null,
27
27
  created_at: null,
28
28
  name: null,
@@ -1,4 +1,4 @@
1
- # ModerationAPI::ActionsGet200ResponseWebhooksInner
1
+ # ModerationApi::ActionsGet200ResponseWebhooksInner
2
2
 
3
3
  ## Properties
4
4
 
@@ -15,7 +15,7 @@
15
15
  ```ruby
16
16
  require 'moderation_api'
17
17
 
18
- instance = ModerationAPI::ActionsGet200ResponseWebhooksInner.new(
18
+ instance = ModerationApi::ActionsGet200ResponseWebhooksInner.new(
19
19
  name: null,
20
20
  url: null,
21
21
  id: null,
@@ -1,4 +1,4 @@
1
- # ModerationAPI::ActionsList200ResponseInner
1
+ # ModerationApi::ActionsList200ResponseInner
2
2
 
3
3
  ## Properties
4
4
 
@@ -21,7 +21,7 @@
21
21
  ```ruby
22
22
  require 'moderation_api'
23
23
 
24
- instance = ModerationAPI::ActionsList200ResponseInner.new(
24
+ instance = ModerationApi::ActionsList200ResponseInner.new(
25
25
  id: null,
26
26
  created_at: null,
27
27
  name: null,
@@ -1,4 +1,4 @@
1
- # ModerationAPI::ActionsList200ResponseInnerPossibleValuesInner
1
+ # ModerationApi::ActionsList200ResponseInnerPossibleValuesInner
2
2
 
3
3
  ## Properties
4
4
 
@@ -11,7 +11,7 @@
11
11
  ```ruby
12
12
  require 'moderation_api'
13
13
 
14
- instance = ModerationAPI::ActionsList200ResponseInnerPossibleValuesInner.new(
14
+ instance = ModerationApi::ActionsList200ResponseInnerPossibleValuesInner.new(
15
15
  value: null
16
16
  )
17
17
  ```
@@ -1,4 +1,4 @@
1
- # ModerationAPI::ActionsList400Response
1
+ # ModerationApi::ActionsList400Response
2
2
 
3
3
  ## Properties
4
4
 
@@ -13,7 +13,7 @@
13
13
  ```ruby
14
14
  require 'moderation_api'
15
15
 
16
- instance = ModerationAPI::ActionsList400Response.new(
16
+ instance = ModerationApi::ActionsList400Response.new(
17
17
  message: null,
18
18
  code: null,
19
19
  issues: null
@@ -1,4 +1,4 @@
1
- # ModerationAPI::ActionsList400ResponseIssuesInner
1
+ # ModerationApi::ActionsList400ResponseIssuesInner
2
2
 
3
3
  ## Properties
4
4
 
@@ -11,7 +11,7 @@
11
11
  ```ruby
12
12
  require 'moderation_api'
13
13
 
14
- instance = ModerationAPI::ActionsList400ResponseIssuesInner.new(
14
+ instance = ModerationApi::ActionsList400ResponseIssuesInner.new(
15
15
  message: null
16
16
  )
17
17
  ```
@@ -1,4 +1,4 @@
1
- # ModerationAPI::ActionsUpdateRequest
1
+ # ModerationApi::ActionsUpdateRequest
2
2
 
3
3
  ## Properties
4
4
 
@@ -20,7 +20,7 @@
20
20
  ```ruby
21
21
  require 'moderation_api'
22
22
 
23
- instance = ModerationAPI::ActionsUpdateRequest.new(
23
+ instance = ModerationApi::ActionsUpdateRequest.new(
24
24
  key: null,
25
25
  name: null,
26
26
  description: null,