class OrderCloud::ApprovalRuleApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/order_cloud/api/approval_rule_api.rb, line 30
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

create(buyer_id, approval_rule, opts = {}) click to toggle source

@param buyer_id ID of the buyer. @param approval_rule @param [Hash] opts the optional parameters @return [ApprovalRule]

# File lib/order_cloud/api/approval_rule_api.rb, line 40
def create(buyer_id, approval_rule, opts = {})
  data, _status_code, _headers = create_with_http_info(buyer_id, approval_rule, opts)
  return data
end
create_with_http_info(buyer_id, approval_rule, opts = {}) click to toggle source

@param buyer_id ID of the buyer. @param approval_rule @param [Hash] opts the optional parameters @return [Array<(ApprovalRule, Fixnum, Hash)>] ApprovalRule data, response status code and response headers

# File lib/order_cloud/api/approval_rule_api.rb, line 51
def create_with_http_info(buyer_id, approval_rule, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ApprovalRuleApi.create ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling ApprovalRuleApi.create" if buyer_id.nil?
  # verify the required parameter 'approval_rule' is set
  fail ArgumentError, "Missing the required parameter 'approval_rule' when calling ApprovalRuleApi.create" if approval_rule.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/approvalrules".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(approval_rule)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApprovalRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApprovalRuleApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete(buyer_id, approval_rule_id, opts = {}) click to toggle source

@param buyer_id ID of the buyer. @param approval_rule_id ID of the approval rule. @param [Hash] opts the optional parameters @return [nil]

# File lib/order_cloud/api/approval_rule_api.rb, line 101
def delete(buyer_id, approval_rule_id, opts = {})
  delete_with_http_info(buyer_id, approval_rule_id, opts)
  return nil
end
delete_with_http_info(buyer_id, approval_rule_id, opts = {}) click to toggle source

@param buyer_id ID of the buyer. @param approval_rule_id ID of the approval rule. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/order_cloud/api/approval_rule_api.rb, line 112
def delete_with_http_info(buyer_id, approval_rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ApprovalRuleApi.delete ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling ApprovalRuleApi.delete" if buyer_id.nil?
  # verify the required parameter 'approval_rule_id' is set
  fail ArgumentError, "Missing the required parameter 'approval_rule_id' when calling ApprovalRuleApi.delete" if approval_rule_id.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/approvalrules/{approvalRuleID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'approvalRuleID' + '}', approval_rule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApprovalRuleApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get(buyer_id, approval_rule_id, opts = {}) click to toggle source

@param buyer_id ID of the buyer. @param approval_rule_id ID of the approval rule. @param [Hash] opts the optional parameters @return [ApprovalRule]

# File lib/order_cloud/api/approval_rule_api.rb, line 161
def get(buyer_id, approval_rule_id, opts = {})
  data, _status_code, _headers = get_with_http_info(buyer_id, approval_rule_id, opts)
  return data
end
get_with_http_info(buyer_id, approval_rule_id, opts = {}) click to toggle source

@param buyer_id ID of the buyer. @param approval_rule_id ID of the approval rule. @param [Hash] opts the optional parameters @return [Array<(ApprovalRule, Fixnum, Hash)>] ApprovalRule data, response status code and response headers

# File lib/order_cloud/api/approval_rule_api.rb, line 172
def get_with_http_info(buyer_id, approval_rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ApprovalRuleApi.get ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling ApprovalRuleApi.get" if buyer_id.nil?
  # verify the required parameter 'approval_rule_id' is set
  fail ArgumentError, "Missing the required parameter 'approval_rule_id' when calling ApprovalRuleApi.get" if approval_rule_id.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/approvalrules/{approvalRuleID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'approvalRuleID' + '}', approval_rule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApprovalRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApprovalRuleApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list(buyer_id, opts = {}) click to toggle source

@param buyer_id ID of the buyer. @param [Hash] opts the optional parameters @option opts [String] :search Search of the approval rule. @option opts [Array<String>] :search_on Search on of the approval rule. @option opts [Array<String>] :sort_by Sort by of the approval rule. @option opts [Integer] :page Page of the approval rule. @option opts [Integer] :page_size Page size of the approval rule. @option opts [Hash<String, String>] :filters Filters of the approval rule. @return [ListApprovalRule]

# File lib/order_cloud/api/approval_rule_api.rb, line 227
def list(buyer_id, opts = {})
  data, _status_code, _headers = list_with_http_info(buyer_id, opts)
  return data
end
list_with_http_info(buyer_id, opts = {}) click to toggle source

@param buyer_id ID of the buyer. @param [Hash] opts the optional parameters @option opts [String] :search Search of the approval rule. @option opts [Array<String>] :search_on Search on of the approval rule. @option opts [Array<String>] :sort_by Sort by of the approval rule. @option opts [Integer] :page Page of the approval rule. @option opts [Integer] :page_size Page size of the approval rule. @option opts [Hash<String, String>] :filters Filters of the approval rule. @return [Array<(ListApprovalRule, Fixnum, Hash)>] ListApprovalRule data, response status code and response headers

# File lib/order_cloud/api/approval_rule_api.rb, line 243
def list_with_http_info(buyer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ApprovalRuleApi.list ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling ApprovalRuleApi.list" if buyer_id.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/approvalrules".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'searchOn'] = @api_client.build_collection_param(opts[:'search_on'], :csv) if !opts[:'search_on'].nil?
  query_params[:'sortBy'] = @api_client.build_collection_param(opts[:'sort_by'], :csv) if !opts[:'sort_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'filters'] = opts[:'filters'] if !opts[:'filters'].nil?

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListApprovalRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApprovalRuleApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
patch(buyer_id, approval_rule_id, partial_approval_rule, opts = {}) click to toggle source

@param buyer_id ID of the buyer. @param approval_rule_id ID of the approval rule. @param partial_approval_rule @param [Hash] opts the optional parameters @return [ApprovalRule]

# File lib/order_cloud/api/approval_rule_api.rb, line 298
def patch(buyer_id, approval_rule_id, partial_approval_rule, opts = {})
  data, _status_code, _headers = patch_with_http_info(buyer_id, approval_rule_id, partial_approval_rule, opts)
  return data
end
patch_with_http_info(buyer_id, approval_rule_id, partial_approval_rule, opts = {}) click to toggle source

@param buyer_id ID of the buyer. @param approval_rule_id ID of the approval rule. @param partial_approval_rule @param [Hash] opts the optional parameters @return [Array<(ApprovalRule, Fixnum, Hash)>] ApprovalRule data, response status code and response headers

# File lib/order_cloud/api/approval_rule_api.rb, line 310
def patch_with_http_info(buyer_id, approval_rule_id, partial_approval_rule, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ApprovalRuleApi.patch ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling ApprovalRuleApi.patch" if buyer_id.nil?
  # verify the required parameter 'approval_rule_id' is set
  fail ArgumentError, "Missing the required parameter 'approval_rule_id' when calling ApprovalRuleApi.patch" if approval_rule_id.nil?
  # verify the required parameter 'partial_approval_rule' is set
  fail ArgumentError, "Missing the required parameter 'partial_approval_rule' when calling ApprovalRuleApi.patch" if partial_approval_rule.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/approvalrules/{approvalRuleID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'approvalRuleID' + '}', approval_rule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(partial_approval_rule)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApprovalRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApprovalRuleApi#patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update(buyer_id, approval_rule_id, approval_rule, opts = {}) click to toggle source

@param buyer_id ID of the buyer. @param approval_rule_id ID of the approval rule. @param approval_rule @param [Hash] opts the optional parameters @return [ApprovalRule]

# File lib/order_cloud/api/approval_rule_api.rb, line 363
def update(buyer_id, approval_rule_id, approval_rule, opts = {})
  data, _status_code, _headers = update_with_http_info(buyer_id, approval_rule_id, approval_rule, opts)
  return data
end
update_with_http_info(buyer_id, approval_rule_id, approval_rule, opts = {}) click to toggle source

@param buyer_id ID of the buyer. @param approval_rule_id ID of the approval rule. @param approval_rule @param [Hash] opts the optional parameters @return [Array<(ApprovalRule, Fixnum, Hash)>] ApprovalRule data, response status code and response headers

# File lib/order_cloud/api/approval_rule_api.rb, line 375
def update_with_http_info(buyer_id, approval_rule_id, approval_rule, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ApprovalRuleApi.update ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling ApprovalRuleApi.update" if buyer_id.nil?
  # verify the required parameter 'approval_rule_id' is set
  fail ArgumentError, "Missing the required parameter 'approval_rule_id' when calling ApprovalRuleApi.update" if approval_rule_id.nil?
  # verify the required parameter 'approval_rule' is set
  fail ArgumentError, "Missing the required parameter 'approval_rule' when calling ApprovalRuleApi.update" if approval_rule.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/approvalrules/{approvalRuleID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'approvalRuleID' + '}', approval_rule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(approval_rule)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApprovalRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApprovalRuleApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end