moderation_api 1.2.1 → 2.0.0

data/docs/AccountApi.md

@@ -1,74 +0,0 @@
-# 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

@@ -1,26 +0,0 @@
-# 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

@@ -1,20 +0,0 @@
-# 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

@@ -1,36 +0,0 @@
-# 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

@@ -1,24 +0,0 @@
-# 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

@@ -1,20 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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

@@ -1,24 +0,0 @@
-# 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

@@ -1,40 +0,0 @@
-# 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

@@ -1,26 +0,0 @@
-# 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

@@ -1,38 +0,0 @@
-# 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

@@ -1,18 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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

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

data/docs/ActionsUpdateRequest.md

@@ -1,36 +0,0 @@
-# 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
-)
-```
-