moderation_api 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 01b054414c274bbd8477a7eb3119f1590d1ef83474500cdfd7cd2d52ee1ff069
+  data.tar.gz: fc294ed0ba8cf33972dda43dd359a2ff25eb8bfb5bba8d3b438563411c8d3ffb
+SHA512:
+  metadata.gz: 2a72621a0abbc91d8bd61c51a1afeaf0b9e64b0fda84f137ab7a1afd4aa7fc553b8dd548b921da4f9117f3b2e0150c5bdd2e72a5cbfe68c22f1b4cd29dfadc83
+  data.tar.gz: c5f8f6268af67cfb9bf208d32e34aad785a515e8d063f31d5550f47602ec4a8b711f6d8701f80905733dcc32cf580de5a878f96edb1c5336d54f1dbe5f96e61b

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,144 @@
+# moderation_api
+
+ModerationAPI - the Ruby gem for the Moderation API
+
+API for automated content moderation
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 1.2.0
+- Generator version: 7.10.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'moderation_api'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```shell
+gem install moderation_api
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'moderation_api'
+
+# Setup authorization
+ModerationAPI.configure do |config|
+  # Configure Bearer authorization: Authorization
+  config.access_token = 'YOUR_BEARER_TOKEN'
+  # Configure a proc to get access tokens in lieu of the static access_token configuration
+  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' }
+  # Configure faraday connection
+  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
+end
+
+api_instance = ModerationAPI::AccountApi.new
+
+begin
+  #Get account details
+  result = api_instance.account_get
+  p result
+rescue ModerationAPI::ApiError => e
+  puts "Exception when calling AccountApi->account_get: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://moderationapi.com/api/v1*
+
+| Class                            | Method                                                                               | HTTP request                         | Description         |
+| -------------------------------- | ------------------------------------------------------------------------------------ | ------------------------------------ | ------------------- |
+| _ModerationAPI::AccountApi_      | [**account_get**](docs/AccountApi.md#account_get)                                    | **GET** /account                     | Get account details |
+| _ModerationAPI::ModerateApi_     | [**moderation_audio**](docs/ModerateApi.md#moderation_audio)                         | **POST** /moderate/audio             | Analyze audio       |
+| _ModerationAPI::ModerateApi_     | [**moderation_image**](docs/ModerateApi.md#moderation_image)                         | **POST** /moderate/image             | Analyze image       |
+| _ModerationAPI::ModerateApi_     | [**moderation_object**](docs/ModerateApi.md#moderation_object)                       | **POST** /moderate/object            | Analyze object.     |
+| _ModerationAPI::ModerateApi_     | [**moderation_text**](docs/ModerateApi.md#moderation_text)                           | **POST** /moderate/text              | Analyze text.       |
+| _ModerationAPI::ModerateApi_     | [**moderation_video**](docs/ModerateApi.md#moderation_video)                         | **POST** /moderate/video             | Analyze video       |
+| _ModerationAPI::QueueActionsApi_ | [**actions_create**](docs/QueueActionsApi.md#actions_create)                         | **POST** /actions                    | Create an action    |
+| _ModerationAPI::QueueActionsApi_ | [**actions_delete**](docs/QueueActionsApi.md#actions_delete)                         | **DELETE** /actions/{id}             | Delete an action    |
+| _ModerationAPI::QueueActionsApi_ | [**actions_execute**](docs/QueueActionsApi.md#actions_execute)                       | **POST** /actions/execute            | Execute an action   |
+| _ModerationAPI::QueueActionsApi_ | [**actions_execute_deprecated**](docs/QueueActionsApi.md#actions_execute_deprecated) | **POST** /actions/{actionId}/execute | Execute an action   |
+| _ModerationAPI::QueueActionsApi_ | [**actions_get**](docs/QueueActionsApi.md#actions_get)                               | **GET** /actions/{id}                | Get an action       |
+| _ModerationAPI::QueueActionsApi_ | [**actions_list**](docs/QueueActionsApi.md#actions_list)                             | **GET** /actions                     | List actions        |
+| _ModerationAPI::QueueActionsApi_ | [**actions_update**](docs/QueueActionsApi.md#actions_update)                         | **PUT** /actions/{id}                | Update an action    |
+
+## Documentation for Models
+
+- [ModerationAPI::AccountGet200Response](docs/AccountGet200Response.md)
+- [ModerationAPI::AccountGet200ResponseCurrentProject](docs/AccountGet200ResponseCurrentProject.md)
+- [ModerationAPI::ActionsCreateRequest](docs/ActionsCreateRequest.md)
+- [ModerationAPI::ActionsCreateRequestWebhooksInner](docs/ActionsCreateRequestWebhooksInner.md)
+- [ModerationAPI::ActionsDelete200Response](docs/ActionsDelete200Response.md)
+- [ModerationAPI::ActionsExecute200Response](docs/ActionsExecute200Response.md)
+- [ModerationAPI::ActionsExecuteDeprecatedRequest](docs/ActionsExecuteDeprecatedRequest.md)
+- [ModerationAPI::ActionsExecuteRequest](docs/ActionsExecuteRequest.md)
+- [ModerationAPI::ActionsGet200Response](docs/ActionsGet200Response.md)
+- [ModerationAPI::ActionsGet200ResponseWebhooksInner](docs/ActionsGet200ResponseWebhooksInner.md)
+- [ModerationAPI::ActionsList200ResponseInner](docs/ActionsList200ResponseInner.md)
+- [ModerationAPI::ActionsList200ResponseInnerPossibleValuesInner](docs/ActionsList200ResponseInnerPossibleValuesInner.md)
+- [ModerationAPI::ActionsList400Response](docs/ActionsList400Response.md)
+- [ModerationAPI::ActionsList400ResponseIssuesInner](docs/ActionsList400ResponseIssuesInner.md)
+- [ModerationAPI::ActionsUpdateRequest](docs/ActionsUpdateRequest.md)
+- [ModerationAPI::ModerationAudioRequest](docs/ModerationAudioRequest.md)
+- [ModerationAPI::ModerationImage200Response](docs/ModerationImage200Response.md)
+- [ModerationAPI::ModerationImage200ResponseLabelsInner](docs/ModerationImage200ResponseLabelsInner.md)
+- [ModerationAPI::ModerationImageRequest](docs/ModerationImageRequest.md)
+- [ModerationAPI::ModerationObject200Response](docs/ModerationObject200Response.md)
+- [ModerationAPI::ModerationObject200ResponseAllOfEntitiesInner](docs/ModerationObject200ResponseAllOfEntitiesInner.md)
+- [ModerationAPI::ModerationObject200ResponseAllOfFieldsInner](docs/ModerationObject200ResponseAllOfFieldsInner.md)
+- [ModerationAPI::ModerationObject200ResponseAllOfLabelsInner](docs/ModerationObject200ResponseAllOfLabelsInner.md)
+- [ModerationAPI::ModerationObjectRequest](docs/ModerationObjectRequest.md)
+- [ModerationAPI::ModerationObjectRequestValue](docs/ModerationObjectRequestValue.md)
+- [ModerationAPI::ModerationObjectRequestValueDataValue](docs/ModerationObjectRequestValueDataValue.md)
+- [ModerationAPI::ModerationText200Response](docs/ModerationText200Response.md)
+- [ModerationAPI::ModerationText200ResponseAllOfAddress](docs/ModerationText200ResponseAllOfAddress.md)
+- [ModerationAPI::ModerationText200ResponseAllOfEmail](docs/ModerationText200ResponseAllOfEmail.md)
+- [ModerationAPI::ModerationText200ResponseAllOfName](docs/ModerationText200ResponseAllOfName.md)
+- [ModerationAPI::ModerationText200ResponseAllOfNsfw](docs/ModerationText200ResponseAllOfNsfw.md)
+- [ModerationAPI::ModerationText200ResponseAllOfNsfwLabelScores](docs/ModerationText200ResponseAllOfNsfwLabelScores.md)
+- [ModerationAPI::ModerationText200ResponseAllOfPhone](docs/ModerationText200ResponseAllOfPhone.md)
+- [ModerationAPI::ModerationText200ResponseAllOfProfanity](docs/ModerationText200ResponseAllOfProfanity.md)
+- [ModerationAPI::ModerationText200ResponseAllOfPropriety](docs/ModerationText200ResponseAllOfPropriety.md)
+- [ModerationAPI::ModerationText200ResponseAllOfProprietyLabelScores](docs/ModerationText200ResponseAllOfProprietyLabelScores.md)
+- [ModerationAPI::ModerationText200ResponseAllOfQuality](docs/ModerationText200ResponseAllOfQuality.md)
+- [ModerationAPI::ModerationText200ResponseAllOfQualityLabelScores](docs/ModerationText200ResponseAllOfQualityLabelScores.md)
+- [ModerationAPI::ModerationText200ResponseAllOfRequest](docs/ModerationText200ResponseAllOfRequest.md)
+- [ModerationAPI::ModerationText200ResponseAllOfSensitive](docs/ModerationText200ResponseAllOfSensitive.md)
+- [ModerationAPI::ModerationText200ResponseAllOfSentiment](docs/ModerationText200ResponseAllOfSentiment.md)
+- [ModerationAPI::ModerationText200ResponseAllOfSentimentLabelScores](docs/ModerationText200ResponseAllOfSentimentLabelScores.md)
+- [ModerationAPI::ModerationText200ResponseAllOfToxicity](docs/ModerationText200ResponseAllOfToxicity.md)
+- [ModerationAPI::ModerationText200ResponseAllOfToxicityLabelScores](docs/ModerationText200ResponseAllOfToxicityLabelScores.md)
+- [ModerationAPI::ModerationText200ResponseAllOfUrl](docs/ModerationText200ResponseAllOfUrl.md)
+- [ModerationAPI::ModerationText200ResponseAllOfUsername](docs/ModerationText200ResponseAllOfUsername.md)
+- [ModerationAPI::ModerationText200ResponseAllOfWordlist](docs/ModerationText200ResponseAllOfWordlist.md)
+- [ModerationAPI::ModerationText200ResponseAllOfWordlistsInner](docs/ModerationText200ResponseAllOfWordlistsInner.md)
+- [ModerationAPI::ModerationTextRequest](docs/ModerationTextRequest.md)
+- [ModerationAPI::ModerationVideo200Response](docs/ModerationVideo200Response.md)
+- [ModerationAPI::ModerationVideoRequest](docs/ModerationVideoRequest.md)
+
+## Documentation for Authorization
+
+Authentication schemes defined for the API:
+
+### Authorization
+
+- **Type**: Bearer authentication

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AccountApi.md

@@ -0,0 +1,74 @@
+# ModerationAPI::AccountApi
+
+All URIs are relative to *https://moderationapi.com/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**account_get**](AccountApi.md#account_get) | **GET** /account | Get account details |
+
+
+## account_get
+
+> <AccountGet200Response> account_get
+
+Get account details
+
+Get account details
+
+### Examples
+
+```ruby
+require 'time'
+require 'moderation_api'
+# setup authorization
+ModerationAPI.configure do |config|
+  # Configure Bearer authorization: Authorization
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = ModerationAPI::AccountApi.new
+
+begin
+  # Get account details
+  result = api_instance.account_get
+  p result
+rescue ModerationAPI::ApiError => e
+  puts "Error when calling AccountApi->account_get: #{e}"
+end
+```
+
+#### Using the account_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AccountGet200Response>, Integer, Hash)> account_get_with_http_info
+
+```ruby
+begin
+  # Get account details
+  data, status_code, headers = api_instance.account_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AccountGet200Response>
+rescue ModerationAPI::ApiError => e
+  puts "Error when calling AccountApi->account_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**AccountGet200Response**](AccountGet200Response.md)
+
+### Authorization
+
+[Authorization](../README.md#Authorization)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AccountGet200Response.md

@@ -0,0 +1,26 @@
+# ModerationAPI::AccountGet200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **paid_plan_name** | **String** |  |  |
+| **text_api_quota** | **Float** |  |  |
+| **remaining_quota** | **Float** |  |  |
+| **current_project** | [**AccountGet200ResponseCurrentProject**](AccountGet200ResponseCurrentProject.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::AccountGet200Response.new(
+  id: null,
+  paid_plan_name: null,
+  text_api_quota: null,
+  remaining_quota: null,
+  current_project: null
+)
+```
+

data/docs/AccountGet200ResponseCurrentProject.md

@@ -0,0 +1,20 @@
+# ModerationAPI::AccountGet200ResponseCurrentProject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::AccountGet200ResponseCurrentProject.new(
+  id: null,
+  name: null
+)
+```
+

data/docs/ActionsCreateRequest.md

@@ -0,0 +1,36 @@
+# ModerationAPI::ActionsCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the action. |  |
+| **key** | **String** | User defined key of the action. | [optional] |
+| **description** | **String** | The description of the action. | [optional] |
+| **queue_behaviour** | **String** | Whether the action resolves and removes the item, unresolves and re-add it to the queue, or does not change the resolve status. | [optional][default to 'NO_CHANGE'] |
+| **filter_in_queue_ids** | **Array<String>** | The IDs of the queues the action is available in. | [optional] |
+| **position** | **String** | Show the action in all queues, selected queues or no queues (to use via API only). | [optional][default to 'ALL_QUEUES'] |
+| **possible_values** | [**Array<ActionsList200ResponseInnerPossibleValuesInner>**](ActionsList200ResponseInnerPossibleValuesInner.md) | The possible values of the action. The user will be prompted to select one of these values when executing the action. | [optional] |
+| **value_required** | **Boolean** | Whether the action requires a value to be executed. | [optional][default to false] |
+| **free_text** | **Boolean** | Whether the action allows any text to be entered as a value or if it must be one of the possible values. | [optional][default to false] |
+| **webhooks** | [**Array<ActionsCreateRequestWebhooksInner>**](ActionsCreateRequestWebhooksInner.md) | The action's webhooks. | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ActionsCreateRequest.new(
+  name: null,
+  key: null,
+  description: null,
+  queue_behaviour: null,
+  filter_in_queue_ids: null,
+  position: null,
+  possible_values: null,
+  value_required: null,
+  free_text: null,
+  webhooks: null
+)
+```
+

data/docs/ActionsCreateRequestWebhooksInner.md

@@ -0,0 +1,24 @@
+# ModerationAPI::ActionsCreateRequestWebhooksInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The webhook's name, used to identify it in the dashboard |  |
+| **url** | **String** | The webhook's URL. We'll call this URL when the event occurs. |  |
+| **description** | **String** | The webhook's description | [optional] |
+| **id** | **String** | ID of an existing webhook or undefined if this is a new webhook. | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ActionsCreateRequestWebhooksInner.new(
+  name: null,
+  url: null,
+  description: null,
+  id: null
+)
+```
+

data/docs/ActionsDelete200Response.md

@@ -0,0 +1,20 @@
+# ModerationAPI::ActionsDelete200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deleted** | **Boolean** | Whether the action was deleted. |  |
+| **id** | **String** | The ID of the action. |  |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ActionsDelete200Response.new(
+  deleted: null,
+  id: null
+)
+```
+

data/docs/ActionsExecute200Response.md

@@ -0,0 +1,22 @@
+# ModerationAPI::ActionsExecute200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** | Action executed successfully. |  |
+| **action_id** | **String** | The ID of the action. |  |
+| **ids** | **Array<String>** | The IDs of the content items. |  |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ActionsExecute200Response.new(
+  success: null,
+  action_id: null,
+  ids: null
+)
+```
+

data/docs/ActionsExecuteDeprecatedRequest.md

@@ -0,0 +1,22 @@
+# ModerationAPI::ActionsExecuteDeprecatedRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content_ids** | **Array<String>** | The IDs of the content items to perform the action on. |  |
+| **queue_id** | **String** | The ID of the queue the action was performed from if any. | [optional] |
+| **value** | **String** | The value of the action. Useful to set a reason for the action etc. | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ActionsExecuteDeprecatedRequest.new(
+  content_ids: null,
+  queue_id: null,
+  value: null
+)
+```
+

data/docs/ActionsExecuteRequest.md

@@ -0,0 +1,24 @@
+# ModerationAPI::ActionsExecuteRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content_ids** | **Array<String>** | The IDs of the content items to perform the action on. |  |
+| **action_id** | **String** | The ID or key of the action to execute. |  |
+| **queue_id** | **String** | The ID of the queue the action was performed from if any. | [optional] |
+| **value** | **String** | The value of the action. Useful to set a reason for the action etc. | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ActionsExecuteRequest.new(
+  content_ids: null,
+  action_id: null,
+  queue_id: null,
+  value: null
+)
+```
+

data/docs/ActionsGet200Response.md

@@ -0,0 +1,40 @@
+# ModerationAPI::ActionsGet200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the action. |  |
+| **created_at** | **Time** | The date the action was created. |  |
+| **name** | **String** | The name of the action. |  |
+| **key** | **String** | User defined key of the action. | [optional] |
+| **description** | **String** | The description of the action. | [optional] |
+| **queue_behaviour** | **String** | Whether the action resolves and removes the item, unresolves and re-add it to the queue, or does not change the resolve status. | [optional][default to 'NO_CHANGE'] |
+| **filter_in_queue_ids** | **Array<String>** | The IDs of the queues the action is available in. | [optional] |
+| **position** | **String** | Show the action in all queues, selected queues or no queues (to use via API only). | [optional][default to 'ALL_QUEUES'] |
+| **possible_values** | [**Array<ActionsList200ResponseInnerPossibleValuesInner>**](ActionsList200ResponseInnerPossibleValuesInner.md) | The possible values of the action. The user will be prompted to select one of these values when executing the action. | [optional] |
+| **value_required** | **Boolean** | Whether the action requires a value to be executed. | [optional][default to false] |
+| **free_text** | **Boolean** | Whether the action allows any text to be entered as a value or if it must be one of the possible values. | [optional][default to false] |
+| **webhooks** | [**Array<ActionsGet200ResponseWebhooksInner>**](ActionsGet200ResponseWebhooksInner.md) | The action's webhooks. | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ActionsGet200Response.new(
+  id: null,
+  created_at: null,
+  name: null,
+  key: null,
+  description: null,
+  queue_behaviour: null,
+  filter_in_queue_ids: null,
+  position: null,
+  possible_values: null,
+  value_required: null,
+  free_text: null,
+  webhooks: null
+)
+```
+

data/docs/ActionsGet200ResponseWebhooksInner.md

@@ -0,0 +1,26 @@
+# ModerationAPI::ActionsGet200ResponseWebhooksInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The webhook's name, used to identify it in the dashboard |  |
+| **url** | **String** | The webhook's URL. We'll call this URL when the event occurs. |  |
+| **id** | **String** | The ID of the webhook. |  |
+| **description** | **String** | The webhook's description | [optional] |
+| **moderation_action_id** | **String** | The ID of the moderation action to trigger the webhook on. Only used for moderation action webhooks. | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ActionsGet200ResponseWebhooksInner.new(
+  name: null,
+  url: null,
+  id: null,
+  description: null,
+  moderation_action_id: null
+)
+```
+

data/docs/ActionsList200ResponseInner.md

@@ -0,0 +1,38 @@
+# ModerationAPI::ActionsList200ResponseInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the action. |  |
+| **created_at** | **Time** | The date the action was created. |  |
+| **name** | **String** | The name of the action. |  |
+| **key** | **String** | User defined key of the action. | [optional] |
+| **description** | **String** | The description of the action. | [optional] |
+| **queue_behaviour** | **String** | Whether the action resolves and removes the item, unresolves and re-add it to the queue, or does not change the resolve status. | [optional][default to 'NO_CHANGE'] |
+| **filter_in_queue_ids** | **Array<String>** | The IDs of the queues the action is available in. | [optional] |
+| **position** | **String** | Show the action in all queues, selected queues or no queues (to use via API only). | [optional][default to 'ALL_QUEUES'] |
+| **possible_values** | [**Array<ActionsList200ResponseInnerPossibleValuesInner>**](ActionsList200ResponseInnerPossibleValuesInner.md) | The possible values of the action. The user will be prompted to select one of these values when executing the action. | [optional] |
+| **value_required** | **Boolean** | Whether the action requires a value to be executed. | [optional][default to false] |
+| **free_text** | **Boolean** | Whether the action allows any text to be entered as a value or if it must be one of the possible values. | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ActionsList200ResponseInner.new(
+  id: null,
+  created_at: null,
+  name: null,
+  key: null,
+  description: null,
+  queue_behaviour: null,
+  filter_in_queue_ids: null,
+  position: null,
+  possible_values: null,
+  value_required: null,
+  free_text: null
+)
+```
+

data/docs/ActionsList200ResponseInnerPossibleValuesInner.md

@@ -0,0 +1,18 @@
+# ModerationAPI::ActionsList200ResponseInnerPossibleValuesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **String** | The value of the action. |  |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ActionsList200ResponseInnerPossibleValuesInner.new(
+  value: null
+)
+```
+

data/docs/ActionsList400Response.md

@@ -0,0 +1,22 @@
+# ModerationAPI::ActionsList400Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  |  |
+| **code** | **String** |  |  |
+| **issues** | [**Array<ActionsList400ResponseIssuesInner>**](ActionsList400ResponseIssuesInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ActionsList400Response.new(
+  message: null,
+  code: null,
+  issues: null
+)
+```
+

data/docs/ActionsList400ResponseIssuesInner.md

@@ -0,0 +1,18 @@
+# ModerationAPI::ActionsList400ResponseIssuesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ActionsList400ResponseIssuesInner.new(
+  message: null
+)
+```
+

data/docs/ActionsUpdateRequest.md

@@ -0,0 +1,36 @@
+# ModerationAPI::ActionsUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | User defined key of the action. | [optional] |
+| **name** | **String** | The name of the action. | [optional] |
+| **description** | **String** | The description of the action. | [optional] |
+| **queue_behaviour** | **String** | Whether the action resolves and removes the item, unresolves and re-add it to the queue, or does not change the resolve status. | [optional][default to 'NO_CHANGE'] |
+| **filter_in_queue_ids** | **Array<String>** | The IDs of the queues the action is available in. | [optional] |
+| **position** | **String** | Show the action in all queues, selected queues or no queues (to use via API only). | [optional][default to 'ALL_QUEUES'] |
+| **possible_values** | [**Array<ActionsList200ResponseInnerPossibleValuesInner>**](ActionsList200ResponseInnerPossibleValuesInner.md) | The possible values of the action. The user will be prompted to select one of these values when executing the action. | [optional] |
+| **value_required** | **Boolean** | Whether the action requires a value to be executed. | [optional][default to false] |
+| **free_text** | **Boolean** | Whether the action allows any text to be entered as a value or if it must be one of the possible values. | [optional][default to false] |
+| **webhooks** | [**Array<ActionsCreateRequestWebhooksInner>**](ActionsCreateRequestWebhooksInner.md) | The action's webhooks. | [optional] |
+
+## Example
+
+```ruby
+require 'moderation_api'
+
+instance = ModerationAPI::ActionsUpdateRequest.new(
+  key: null,
+  name: null,
+  description: null,
+  queue_behaviour: null,
+  filter_in_queue_ids: null,
+  position: null,
+  possible_values: null,
+  value_required: null,
+  free_text: null,
+  webhooks: null
+)
+```
+