moderation_api 1.2.2 → 2.0.0

data/docs/ModerationVideo200Response.md

@@ -1,24 +0,0 @@
-# ModerationApi::ModerationVideo200Response
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **status** | **String** | Success if the request was successful |  |
-| **request** | [**ModerationText200ResponseAllOfRequest**](ModerationText200ResponseAllOfRequest.md) |  |  |
-| **flagged** | **Boolean** | Whether the content was flagged by any models |  |
-| **content_id** | **String** | The ID of the content. Only returned if the content was stored. | [optional] |
-
-## Example
-
-```ruby
-require 'moderation_api'
-
-instance = ModerationApi::ModerationVideo200Response.new(
-  status: null,
-  request: null,
-  flagged: null,
-  content_id: null
-)
-```
-

data/docs/ModerationVideoRequest.md

@@ -1,28 +0,0 @@
-# ModerationApi::ModerationVideoRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **url** | **String** | The URL of the video you want to analyze. |  |
-| **content_id** | **String** | The unique ID of the content in your database. | [optional] |
-| **do_not_store** | **Boolean** | Do not store the content. The content won't enter the review queue | [optional] |
-| **author_id** | **String** | The author of the content. | [optional] |
-| **context_id** | **String** | For example the ID of a chat room or a post | [optional] |
-| **metadata** | **Hash<String, Object>** | Any metadata you want to store with the content | [optional] |
-
-## Example
-
-```ruby
-require 'moderation_api'
-
-instance = ModerationApi::ModerationVideoRequest.new(
-  url: null,
-  content_id: null,
-  do_not_store: null,
-  author_id: null,
-  context_id: null,
-  metadata: null
-)
-```
-

data/docs/QueueActionsApi.md

@@ -1,503 +0,0 @@
-# ModerationApi::QueueActionsApi
-
-All URIs are relative to *https://moderationapi.com/api/v1*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**actions_create**](QueueActionsApi.md#actions_create) | **POST** /actions | Create an action |
-| [**actions_delete**](QueueActionsApi.md#actions_delete) | **DELETE** /actions/{id} | Delete an action |
-| [**actions_execute**](QueueActionsApi.md#actions_execute) | **POST** /actions/execute | Execute an action |
-| [**actions_execute_deprecated**](QueueActionsApi.md#actions_execute_deprecated) | **POST** /actions/{actionId}/execute | Execute an action |
-| [**actions_get**](QueueActionsApi.md#actions_get) | **GET** /actions/{id} | Get an action |
-| [**actions_list**](QueueActionsApi.md#actions_list) | **GET** /actions | List actions |
-| [**actions_update**](QueueActionsApi.md#actions_update) | **PUT** /actions/{id} | Update an action |
-
-
-## actions_create
-
-> <ActionsList200ResponseInner> actions_create(actions_create_request)
-
-Create an action
-
-Create an action.
-
-### 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::QueueActionsApi.new
-actions_create_request = ModerationApi::ActionsCreateRequest.new({name: 'name_example'}) # ActionsCreateRequest | 
-
-begin
-  # Create an action
-  result = api_instance.actions_create(actions_create_request)
-  p result
-rescue ModerationApi::ApiError => e
-  puts "Error when calling QueueActionsApi->actions_create: #{e}"
-end
-```
-
-#### Using the actions_create_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<ActionsList200ResponseInner>, Integer, Hash)> actions_create_with_http_info(actions_create_request)
-
-```ruby
-begin
-  # Create an action
-  data, status_code, headers = api_instance.actions_create_with_http_info(actions_create_request)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ActionsList200ResponseInner>
-rescue ModerationApi::ApiError => e
-  puts "Error when calling QueueActionsApi->actions_create_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **actions_create_request** | [**ActionsCreateRequest**](ActionsCreateRequest.md) |  |  |
-
-### Return type
-
-[**ActionsList200ResponseInner**](ActionsList200ResponseInner.md)
-
-### Authorization
-
-[Authorization](../README.md#Authorization)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## actions_delete
-
-> <ActionsDelete200Response> actions_delete(id)
-
-Delete an action
-
-Delete an action and all of its webhooks.
-
-### 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::QueueActionsApi.new
-id = '60c9e1c0e4e7e1001c7a0e1d' # String | The ID of the action to delete.
-
-begin
-  # Delete an action
-  result = api_instance.actions_delete(id)
-  p result
-rescue ModerationApi::ApiError => e
-  puts "Error when calling QueueActionsApi->actions_delete: #{e}"
-end
-```
-
-#### Using the actions_delete_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<ActionsDelete200Response>, Integer, Hash)> actions_delete_with_http_info(id)
-
-```ruby
-begin
-  # Delete an action
-  data, status_code, headers = api_instance.actions_delete_with_http_info(id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ActionsDelete200Response>
-rescue ModerationApi::ApiError => e
-  puts "Error when calling QueueActionsApi->actions_delete_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** | The ID of the action to delete. |  |
-
-### Return type
-
-[**ActionsDelete200Response**](ActionsDelete200Response.md)
-
-### Authorization
-
-[Authorization](../README.md#Authorization)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## actions_execute
-
-> <ActionsExecute200Response> actions_execute(actions_execute_request)
-
-Execute an action
-
-Execute an action on a set of content items in a queue.
-
-### 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::QueueActionsApi.new
-actions_execute_request = ModerationApi::ActionsExecuteRequest.new({content_ids: ['content_ids_example'], action_id: 'action_id_example'}) # ActionsExecuteRequest | 
-
-begin
-  # Execute an action
-  result = api_instance.actions_execute(actions_execute_request)
-  p result
-rescue ModerationApi::ApiError => e
-  puts "Error when calling QueueActionsApi->actions_execute: #{e}"
-end
-```
-
-#### Using the actions_execute_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<ActionsExecute200Response>, Integer, Hash)> actions_execute_with_http_info(actions_execute_request)
-
-```ruby
-begin
-  # Execute an action
-  data, status_code, headers = api_instance.actions_execute_with_http_info(actions_execute_request)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ActionsExecute200Response>
-rescue ModerationApi::ApiError => e
-  puts "Error when calling QueueActionsApi->actions_execute_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **actions_execute_request** | [**ActionsExecuteRequest**](ActionsExecuteRequest.md) |  |  |
-
-### Return type
-
-[**ActionsExecute200Response**](ActionsExecute200Response.md)
-
-### Authorization
-
-[Authorization](../README.md#Authorization)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## actions_execute_deprecated
-
-> <ActionsExecute200Response> actions_execute_deprecated(action_id, actions_execute_deprecated_request)
-
-Execute an action
-
-Execute an action on a set of content items in a queue.
-
-### 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::QueueActionsApi.new
-action_id = 'action_id_example' # String | The ID or key of the action to execute.
-actions_execute_deprecated_request = ModerationApi::ActionsExecuteDeprecatedRequest.new({content_ids: ['content_ids_example']}) # ActionsExecuteDeprecatedRequest | 
-
-begin
-  # Execute an action
-  result = api_instance.actions_execute_deprecated(action_id, actions_execute_deprecated_request)
-  p result
-rescue ModerationApi::ApiError => e
-  puts "Error when calling QueueActionsApi->actions_execute_deprecated: #{e}"
-end
-```
-
-#### Using the actions_execute_deprecated_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<ActionsExecute200Response>, Integer, Hash)> actions_execute_deprecated_with_http_info(action_id, actions_execute_deprecated_request)
-
-```ruby
-begin
-  # Execute an action
-  data, status_code, headers = api_instance.actions_execute_deprecated_with_http_info(action_id, actions_execute_deprecated_request)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ActionsExecute200Response>
-rescue ModerationApi::ApiError => e
-  puts "Error when calling QueueActionsApi->actions_execute_deprecated_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **action_id** | **String** | The ID or key of the action to execute. |  |
-| **actions_execute_deprecated_request** | [**ActionsExecuteDeprecatedRequest**](ActionsExecuteDeprecatedRequest.md) |  |  |
-
-### Return type
-
-[**ActionsExecute200Response**](ActionsExecute200Response.md)
-
-### Authorization
-
-[Authorization](../README.md#Authorization)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## actions_get
-
-> <ActionsGet200Response> actions_get(id)
-
-Get an action
-
-Get an action by ID.
-
-### 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::QueueActionsApi.new
-id = '60c9e1c0e4e7e1001c7a0e1d' # String | The ID of the action to get.
-
-begin
-  # Get an action
-  result = api_instance.actions_get(id)
-  p result
-rescue ModerationApi::ApiError => e
-  puts "Error when calling QueueActionsApi->actions_get: #{e}"
-end
-```
-
-#### Using the actions_get_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<ActionsGet200Response>, Integer, Hash)> actions_get_with_http_info(id)
-
-```ruby
-begin
-  # Get an action
-  data, status_code, headers = api_instance.actions_get_with_http_info(id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ActionsGet200Response>
-rescue ModerationApi::ApiError => e
-  puts "Error when calling QueueActionsApi->actions_get_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** | The ID of the action to get. |  |
-
-### Return type
-
-[**ActionsGet200Response**](ActionsGet200Response.md)
-
-### Authorization
-
-[Authorization](../README.md#Authorization)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## actions_list
-
-> <Array<ActionsList200ResponseInner>> actions_list(opts)
-
-List actions
-
-List actions for the current user.
-
-### 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::QueueActionsApi.new
-opts = {
-  queue_id: '60c9e1c0e4e7e1001c7a0e1d' # String | Only return actions available in this queue.
-}
-
-begin
-  # List actions
-  result = api_instance.actions_list(opts)
-  p result
-rescue ModerationApi::ApiError => e
-  puts "Error when calling QueueActionsApi->actions_list: #{e}"
-end
-```
-
-#### Using the actions_list_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<Array<ActionsList200ResponseInner>>, Integer, Hash)> actions_list_with_http_info(opts)
-
-```ruby
-begin
-  # List actions
-  data, status_code, headers = api_instance.actions_list_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Array<ActionsList200ResponseInner>>
-rescue ModerationApi::ApiError => e
-  puts "Error when calling QueueActionsApi->actions_list_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **queue_id** | **String** | Only return actions available in this queue. | [optional] |
-
-### Return type
-
-[**Array&lt;ActionsList200ResponseInner&gt;**](ActionsList200ResponseInner.md)
-
-### Authorization
-
-[Authorization](../README.md#Authorization)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## actions_update
-
-> <ActionsList200ResponseInner> actions_update(id, actions_update_request)
-
-Update an action
-
-Update an action.
-
-### 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::QueueActionsApi.new
-id = '60c9e1c0e4e7e1001c7a0e1d' # String | The ID of the action to update.
-actions_update_request = ModerationApi::ActionsUpdateRequest.new # ActionsUpdateRequest | 
-
-begin
-  # Update an action
-  result = api_instance.actions_update(id, actions_update_request)
-  p result
-rescue ModerationApi::ApiError => e
-  puts "Error when calling QueueActionsApi->actions_update: #{e}"
-end
-```
-
-#### Using the actions_update_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<ActionsList200ResponseInner>, Integer, Hash)> actions_update_with_http_info(id, actions_update_request)
-
-```ruby
-begin
-  # Update an action
-  data, status_code, headers = api_instance.actions_update_with_http_info(id, actions_update_request)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ActionsList200ResponseInner>
-rescue ModerationApi::ApiError => e
-  puts "Error when calling QueueActionsApi->actions_update_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** | The ID of the action to update. |  |
-| **actions_update_request** | [**ActionsUpdateRequest**](ActionsUpdateRequest.md) |  |  |
-
-### Return type
-
-[**ActionsList200ResponseInner**](ActionsList200ResponseInner.md)
-
-### Authorization
-
-[Authorization](../README.md#Authorization)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-

data/git_push.sh

@@ -1,57 +0,0 @@
-#!/bin/sh
-# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
-#
-# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
-
-git_user_id=$1
-git_repo_id=$2
-release_note=$3
-git_host=$4
-
-if [ "$git_host" = "" ]; then
-    git_host="github.com"
-    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
-fi
-
-if [ "$git_user_id" = "" ]; then
-    git_user_id="GIT_USER_ID"
-    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
-fi
-
-if [ "$git_repo_id" = "" ]; then
-    git_repo_id="GIT_REPO_ID"
-    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
-fi
-
-if [ "$release_note" = "" ]; then
-    release_note="Minor update"
-    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
-fi
-
-# Initialize the local directory as a Git repository
-git init
-
-# Adds the files in the local repository and stages them for commit.
-git add .
-
-# Commits the tracked changes and prepares them to be pushed to a remote repository.
-git commit -m "$release_note"
-
-# Sets the new remote
-git_remote=$(git remote)
-if [ "$git_remote" = "" ]; then # git remote not defined
-
-    if [ "$GIT_TOKEN" = "" ]; then
-        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
-        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
-    else
-        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
-    fi
-
-fi
-
-git pull origin master
-
-# Pushes (Forces) the changes in the local repository up to the remote repository
-echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
-git push origin master 2>&1 | grep -v 'To https'

data/lib/moderation_api/api/account_api.rb

@@ -1,79 +0,0 @@
-=begin
-#Moderation API
-
-#API for automated content moderation
-
-The version of the OpenAPI document: 1.0.0
-
-Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
-
-=end
-
-require 'cgi'
-
-module ModerationApi
-  class AccountApi
-    attr_accessor :api_client
-
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-    # Get account details
-    # Get account details
-    # @param [Hash] opts the optional parameters
-    # @return [AccountGet200Response]
-    def account_get(opts = {})
-      data, _status_code, _headers = account_get_with_http_info(opts)
-      data
-    end
-
-    # Get account details
-    # Get account details
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(AccountGet200Response, Integer, Hash)>] AccountGet200Response data, response status code and response headers
-    def account_get_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AccountApi.account_get ...'
-      end
-      # resource path
-      local_var_path = '/account'
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:debug_body]
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'AccountGet200Response'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['Authorization']
-
-      new_options = opts.merge(
-        :operation => :"AccountApi.account_get",
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AccountApi#account_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-  end
-end