class OrderCloud::MessageSendersApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

delete_assignment(message_sender_id, opts = {}) click to toggle source

@param message_sender_id ID of the message sender. @param [Hash] opts the optional parameters @option opts [String] :buyer_id ID of the buyer. @option opts [String] :user_id ID of the user. @option opts [String] :user_group_id ID of the user group. @return [nil]

# File lib/order_cloud/api/message_senders_api.rb, line 42
def delete_assignment(message_sender_id, opts = {})
  delete_assignment_with_http_info(message_sender_id, opts)
  return nil
end
delete_assignment_with_http_info(message_sender_id, opts = {}) click to toggle source

@param message_sender_id ID of the message sender. @param [Hash] opts the optional parameters @option opts [String] :buyer_id ID of the buyer. @option opts [String] :user_id ID of the user. @option opts [String] :user_group_id ID of the user group. @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/order_cloud/api/message_senders_api.rb, line 55
def delete_assignment_with_http_info(message_sender_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessageSendersApi.delete_assignment ..."
  end
  # verify the required parameter 'message_sender_id' is set
  fail ArgumentError, "Missing the required parameter 'message_sender_id' when calling MessageSendersApi.delete_assignment" if message_sender_id.nil?
  # resource path
  local_var_path = "/messagesenders/{messageSenderID}/assignments".sub('{format}','json').sub('{' + 'messageSenderID' + '}', message_sender_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'buyerID'] = opts[:'buyer_id'] if !opts[:'buyer_id'].nil?
  query_params[:'userID'] = opts[:'user_id'] if !opts[:'user_id'].nil?
  query_params[:'userGroupID'] = opts[:'user_group_id'] if !opts[:'user_group_id'].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(: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: MessageSendersApi#delete_assignment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get(message_sender_id, opts = {}) click to toggle source

@param message_sender_id ID of the message sender. @param [Hash] opts the optional parameters @return [MessageSender]

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

@param message_sender_id ID of the message sender. @param [Hash] opts the optional parameters @return [Array<(MessageSender, Fixnum, Hash)>] MessageSender data, response status code and response headers

# File lib/order_cloud/api/message_senders_api.rb, line 114
def get_with_http_info(message_sender_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessageSendersApi.get ..."
  end
  # verify the required parameter 'message_sender_id' is set
  fail ArgumentError, "Missing the required parameter 'message_sender_id' when calling MessageSendersApi.get" if message_sender_id.nil?
  # resource path
  local_var_path = "/messagesenders/{messageSenderID}".sub('{format}','json').sub('{' + 'messageSenderID' + '}', message_sender_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 => 'MessageSender')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessageSendersApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list(opts = {}) click to toggle source

@param [Hash] opts the optional parameters @option opts [String] :search Search of the message sender. @option opts [Array<String>] :search_on Search on of the message sender. @option opts [Array<String>] :sort_by Sort by of the message sender. @option opts [Integer] :page Page of the message sender. @option opts [Integer] :page_size Page size of the message sender. @option opts [Hash<String, String>] :filters Filters of the message sender. @return [ListMessageSender]

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

@param [Hash] opts the optional parameters @option opts [String] :buyer_id ID of the buyer. @option opts [String] :message_sender_id ID of the message sender. @option opts [String] :user_id ID of the user. @option opts [String] :user_group_id ID of the user group. @option opts [String] :level Level of the message sender. @option opts [Integer] :page Page of the message sender. @option opts [Integer] :page_size Page size of the message sender. @return [ListMessageSenderAssignment]

# File lib/order_cloud/api/message_senders_api.rb, line 238
def list_assignments(opts = {})
  data, _status_code, _headers = list_assignments_with_http_info(opts)
  return data
end
list_assignments_with_http_info(opts = {}) click to toggle source

@param [Hash] opts the optional parameters @option opts [String] :buyer_id ID of the buyer. @option opts [String] :message_sender_id ID of the message sender. @option opts [String] :user_id ID of the user. @option opts [String] :user_group_id ID of the user group. @option opts [String] :level Level of the message sender. @option opts [Integer] :page Page of the message sender. @option opts [Integer] :page_size Page size of the message sender. @return [Array<(ListMessageSenderAssignment, Fixnum, Hash)>] ListMessageSenderAssignment data, response status code and response headers

# File lib/order_cloud/api/message_senders_api.rb, line 254
def list_assignments_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessageSendersApi.list_assignments ..."
  end
  # resource path
  local_var_path = "/messagesenders/assignments".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'buyerID'] = opts[:'buyer_id'] if !opts[:'buyer_id'].nil?
  query_params[:'messageSenderID'] = opts[:'message_sender_id'] if !opts[:'message_sender_id'].nil?
  query_params[:'userID'] = opts[:'user_id'] if !opts[:'user_id'].nil?
  query_params[:'userGroupID'] = opts[:'user_group_id'] if !opts[:'user_group_id'].nil?
  query_params[:'level'] = opts[:'level'] if !opts[:'level'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].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 => 'ListMessageSenderAssignment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessageSendersApi#list_assignments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_cc_listener_assignments(opts = {}) click to toggle source

@param [Hash] opts the optional parameters @option opts [String] :search Search of the message sender. @option opts [Array<String>] :search_on Search on of the message sender. @option opts [Array<String>] :sort_by Sort by of the message sender. @option opts [Integer] :page Page of the message sender. @option opts [Integer] :page_size Page size of the message sender. @option opts [Hash<String, String>] :filters Filters of the message sender. @return [ListMessageCCListenerAssignment]

# File lib/order_cloud/api/message_senders_api.rb, line 311
def list_cc_listener_assignments(opts = {})
  data, _status_code, _headers = list_cc_listener_assignments_with_http_info(opts)
  return data
end
list_cc_listener_assignments_with_http_info(opts = {}) click to toggle source

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

# File lib/order_cloud/api/message_senders_api.rb, line 326
def list_cc_listener_assignments_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessageSendersApi.list_cc_listener_assignments ..."
  end
  # resource path
  local_var_path = "/messagesenders/CCListenerAssignments".sub('{format}','json')

  # 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 => 'ListMessageCCListenerAssignment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessageSendersApi#list_cc_listener_assignments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_with_http_info(opts = {}) click to toggle source

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

# File lib/order_cloud/api/message_senders_api.rb, line 181
def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessageSendersApi.list ..."
  end
  # resource path
  local_var_path = "/messagesenders".sub('{format}','json')

  # 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 => 'ListMessageSender')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessageSendersApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
save_assignment(assignment, opts = {}) click to toggle source

@param assignment @param [Hash] opts the optional parameters @return [nil]

# File lib/order_cloud/api/message_senders_api.rb, line 377
def save_assignment(assignment, opts = {})
  save_assignment_with_http_info(assignment, opts)
  return nil
end
save_assignment_with_http_info(assignment, opts = {}) click to toggle source

@param assignment @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/order_cloud/api/message_senders_api.rb, line 387
def save_assignment_with_http_info(assignment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessageSendersApi.save_assignment ..."
  end
  # verify the required parameter 'assignment' is set
  fail ArgumentError, "Missing the required parameter 'assignment' when calling MessageSendersApi.save_assignment" if assignment.nil?
  # resource path
  local_var_path = "/messagesenders/assignments".sub('{format}','json')

  # 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(assignment)
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessageSendersApi#save_assignment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
save_cc_listener_assignment(assignment, opts = {}) click to toggle source

@param assignment @param [Hash] opts the optional parameters @return [nil]

# File lib/order_cloud/api/message_senders_api.rb, line 433
def save_cc_listener_assignment(assignment, opts = {})
  save_cc_listener_assignment_with_http_info(assignment, opts)
  return nil
end
save_cc_listener_assignment_with_http_info(assignment, opts = {}) click to toggle source

@param assignment @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/order_cloud/api/message_senders_api.rb, line 443
def save_cc_listener_assignment_with_http_info(assignment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessageSendersApi.save_cc_listener_assignment ..."
  end
  # verify the required parameter 'assignment' is set
  fail ArgumentError, "Missing the required parameter 'assignment' when calling MessageSendersApi.save_cc_listener_assignment" if assignment.nil?
  # resource path
  local_var_path = "/messagesenders/CCListenerAssignments".sub('{format}','json')

  # 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(assignment)
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessageSendersApi#save_cc_listener_assignment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end