# 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