docs/QueueActionsApi.md in moderation_api-1.2.1 vs docs/QueueActionsApi.md in moderation_api-1.2.2

- old
+ new

@@ -1,6 +1,6 @@ -# ModerationAPI::QueueActionsApi +# ModerationApi::QueueActionsApi All URIs are relative to *https://moderationapi.com/api/v1* | Method | HTTP request | Description | | ------ | ------------ | ----------- | @@ -25,23 +25,23 @@ ```ruby require 'time' require 'moderation_api' # setup authorization -ModerationAPI.configure do |config| +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 | +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 +rescue ModerationApi::ApiError => e puts "Error when calling QueueActionsApi->actions_create: #{e}" end ``` #### Using the actions_create_with_http_info variant @@ -55,11 +55,11 @@ # 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 +rescue ModerationApi::ApiError => e puts "Error when calling QueueActionsApi->actions_create_with_http_info: #{e}" end ``` ### Parameters @@ -94,23 +94,23 @@ ```ruby require 'time' require 'moderation_api' # setup authorization -ModerationAPI.configure do |config| +ModerationApi.configure do |config| # Configure Bearer authorization: Authorization config.access_token = 'YOUR_BEARER_TOKEN' end -api_instance = ModerationAPI::QueueActionsApi.new +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 +rescue ModerationApi::ApiError => e puts "Error when calling QueueActionsApi->actions_delete: #{e}" end ``` #### Using the actions_delete_with_http_info variant @@ -124,11 +124,11 @@ # 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 +rescue ModerationApi::ApiError => e puts "Error when calling QueueActionsApi->actions_delete_with_http_info: #{e}" end ``` ### Parameters @@ -163,23 +163,23 @@ ```ruby require 'time' require 'moderation_api' # setup authorization -ModerationAPI.configure do |config| +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 | +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 +rescue ModerationApi::ApiError => e puts "Error when calling QueueActionsApi->actions_execute: #{e}" end ``` #### Using the actions_execute_with_http_info variant @@ -193,11 +193,11 @@ # 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 +rescue ModerationApi::ApiError => e puts "Error when calling QueueActionsApi->actions_execute_with_http_info: #{e}" end ``` ### Parameters @@ -232,24 +232,24 @@ ```ruby require 'time' require 'moderation_api' # setup authorization -ModerationAPI.configure do |config| +ModerationApi.configure do |config| # Configure Bearer authorization: Authorization config.access_token = 'YOUR_BEARER_TOKEN' end -api_instance = ModerationAPI::QueueActionsApi.new +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 | +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 +rescue ModerationApi::ApiError => e puts "Error when calling QueueActionsApi->actions_execute_deprecated: #{e}" end ``` #### Using the actions_execute_deprecated_with_http_info variant @@ -263,11 +263,11 @@ # 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 +rescue ModerationApi::ApiError => e puts "Error when calling QueueActionsApi->actions_execute_deprecated_with_http_info: #{e}" end ``` ### Parameters @@ -303,23 +303,23 @@ ```ruby require 'time' require 'moderation_api' # setup authorization -ModerationAPI.configure do |config| +ModerationApi.configure do |config| # Configure Bearer authorization: Authorization config.access_token = 'YOUR_BEARER_TOKEN' end -api_instance = ModerationAPI::QueueActionsApi.new +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 +rescue ModerationApi::ApiError => e puts "Error when calling QueueActionsApi->actions_get: #{e}" end ``` #### Using the actions_get_with_http_info variant @@ -333,11 +333,11 @@ # 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 +rescue ModerationApi::ApiError => e puts "Error when calling QueueActionsApi->actions_get_with_http_info: #{e}" end ``` ### Parameters @@ -372,25 +372,25 @@ ```ruby require 'time' require 'moderation_api' # setup authorization -ModerationAPI.configure do |config| +ModerationApi.configure do |config| # Configure Bearer authorization: Authorization config.access_token = 'YOUR_BEARER_TOKEN' end -api_instance = ModerationAPI::QueueActionsApi.new +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 +rescue ModerationApi::ApiError => e puts "Error when calling QueueActionsApi->actions_list: #{e}" end ``` #### Using the actions_list_with_http_info variant @@ -404,11 +404,11 @@ # 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 +rescue ModerationApi::ApiError => e puts "Error when calling QueueActionsApi->actions_list_with_http_info: #{e}" end ``` ### Parameters @@ -443,24 +443,24 @@ ```ruby require 'time' require 'moderation_api' # setup authorization -ModerationAPI.configure do |config| +ModerationApi.configure do |config| # Configure Bearer authorization: Authorization config.access_token = 'YOUR_BEARER_TOKEN' end -api_instance = ModerationAPI::QueueActionsApi.new +api_instance = ModerationApi::QueueActionsApi.new id = '60c9e1c0e4e7e1001c7a0e1d' # String | The ID of the action to update. -actions_update_request = ModerationAPI::ActionsUpdateRequest.new # ActionsUpdateRequest | +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 +rescue ModerationApi::ApiError => e puts "Error when calling QueueActionsApi->actions_update: #{e}" end ``` #### Using the actions_update_with_http_info variant @@ -474,10 +474,10 @@ # 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 +rescue ModerationApi::ApiError => e puts "Error when calling QueueActionsApi->actions_update_with_http_info: #{e}" end ``` ### Parameters