Class: Vidispine::API::Client::Requests::ItemAccessAdd

Inherits:
BaseRequest
  • Object
show all
Defined in:
lib/vidispine/api/client/requests/item_access_add.rb

Overview

See Also:

Constant Summary collapse

HTTP_METHOD = 
:post
HTTP_PATH = 
'/item/#{path_arguments[:item_id] ? "#{path_arguments[:item_id]}/" : ""}access'
PARAMETERS = 
[
  { :name => :item_id, :send_in => :path },
  { :name => :access_control_document, :required => true, :send_in => :body },
  { :name => :allow_all_items, :aliases => [ :all_items ], :send_in => :none }
]

Constants inherited from BaseRequest

BaseRequest::DEFAULT_PARAMETER_SEND_IN_VALUE, BaseRequest::HTTP_BASE_PATH, BaseRequest::HTTP_SUCCESS_CODE

Instance Attribute Summary

Attributes inherited from BaseRequest

#arguments, #client, #default_parameter_send_in_value, #initial_arguments, #missing_required_arguments, #options, #parameters, #path, #processed_parameters, #query

Instance Method Summary collapse

Methods inherited from BaseRequest

#after_initialize, #base_path, #before_process_parameters, #body_arguments, #eval_http_path?, #http_method, #http_path, #http_success_code, #initialize, #matrix, #matrix_arguments, normalize_argument_hash_keys, normalize_parameter_name, #path_arguments, #path_only, process_parameter, #process_parameters, process_parameters, #query_arguments, #reset_attributes, #success?, #uri_request_path

Constructor Details

This class inherits a constructor from Vidispine::API::Client::Requests::BaseRequest

Instance Method Details

#after_process_parameters ⇒ Object 



16
17
18
19
20
21
 
# File 'lib/vidispine/api/client/requests/item_access_add.rb', line 16

def after_process_parameters
  _item_id = arguments[:item_id]
  unless (arguments[:allow_all_items] == true) || (_item_id && !_item_id.empty?)
    raise ArgumentError, 'Item ID is required unless :allow_all_items parameter is set to true.'
  end
end

#body ⇒ Object 



23
24
25
 
# File 'lib/vidispine/api/client/requests/item_access_add.rb', line 23

def body
  body_arguments[:access_control_document]
end