moderation_api 1.2.2 → 2.0.1

data/Gemfile.lock

@@ -1,87 +0,0 @@
-PATH
-  remote: .
-  specs:
-    moderation_api (1.2.2)
-      faraday (>= 1.0.1, < 3.0)
-      faraday-multipart
-      marcel
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    byebug (11.1.3)
-    coderay (1.1.3)
-    date (3.4.1)
-    diff-lcs (1.5.1)
-    faraday (2.12.2)
-      faraday-net_http (>= 2.0, < 3.5)
-      json
-      logger
-    faraday-multipart (1.1.0)
-      multipart-post (~> 2.0)
-    faraday-net_http (3.4.0)
-      net-http (>= 0.5.0)
-    jaro_winkler (1.5.6)
-    json (2.9.1)
-    logger (1.6.4)
-    marcel (1.0.4)
-    method_source (1.1.0)
-    multipart-post (2.4.1)
-    net-http (0.6.0)
-      uri
-    parallel (1.26.3)
-    parser (3.3.6.0)
-      ast (~> 2.4.1)
-      racc
-    pry (0.14.2)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    pry-byebug (3.10.1)
-      byebug (~> 11.0)
-      pry (>= 0.13, < 0.15)
-    psych (5.2.2)
-      date
-      stringio
-    racc (1.8.1)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    rspec (3.13.0)
-      rspec-core (~> 3.13.0)
-      rspec-expectations (~> 3.13.0)
-      rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.2)
-      rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-support (3.13.2)
-    rubocop (0.66.0)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      psych (>= 3.1.0)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.6)
-    ruby-progressbar (1.13.0)
-    stringio (3.1.2)
-    unicode-display_width (1.5.0)
-    uri (1.0.2)
-
-PLATFORMS
-  ruby
-  x86_64-darwin-24
-
-DEPENDENCIES
-  moderation_api!
-  pry-byebug
-  rake (~> 13.0.1)
-  rspec (~> 3.6, >= 3.6.0)
-  rubocop (~> 0.66.0)
-
-BUNDLED WITH
-   2.6.2

data/Rakefile

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

@@ -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
-)
-```
-