class MailSlurpClient::BulkActionsControllerApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

bulk_create_inboxes(count, opts = {}) click to toggle source

Bulk create Inboxes (email addresses) @param count [Integer] Number of inboxes to be created in bulk @param [Hash] opts the optional parameters @return [Array<Inbox>]

# File lib/mailslurp_client/api/bulk_actions_controller_api.rb, line 26
def bulk_create_inboxes(count, opts = {})
  data, _status_code, _headers = bulk_create_inboxes_with_http_info(count, opts)
  data
end
bulk_create_inboxes_with_http_info(count, opts = {}) click to toggle source

Bulk create Inboxes (email addresses) @param count [Integer] Number of inboxes to be created in bulk @param [Hash] opts the optional parameters @return [Array<(Array<Inbox>, Integer, Hash)>] Array<Inbox> data, response status code and response headers

# File lib/mailslurp_client/api/bulk_actions_controller_api.rb, line 35
def bulk_create_inboxes_with_http_info(count, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BulkActionsControllerApi.bulk_create_inboxes ...'
  end
  # verify the required parameter 'count' is set
  if @api_client.config.client_side_validation && count.nil?
    fail ArgumentError, "Missing the required parameter 'count' when calling BulkActionsControllerApi.bulk_create_inboxes"
  end
  # resource path
  local_var_path = '/bulk/inboxes'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'count'] = count

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Array<Inbox>' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkActionsControllerApi#bulk_create_inboxes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
bulk_delete_inboxes(ids, opts = {}) click to toggle source

Bulk Delete Inboxes @param ids [Array<String>] ids @param [Hash] opts the optional parameters @return [nil]

# File lib/mailslurp_client/api/bulk_actions_controller_api.rb, line 87
def bulk_delete_inboxes(ids, opts = {})
  bulk_delete_inboxes_with_http_info(ids, opts)
  nil
end
bulk_delete_inboxes_with_http_info(ids, opts = {}) click to toggle source

Bulk Delete Inboxes @param ids [Array<String>] ids @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/mailslurp_client/api/bulk_actions_controller_api.rb, line 96
def bulk_delete_inboxes_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BulkActionsControllerApi.bulk_delete_inboxes ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling BulkActionsControllerApi.bulk_delete_inboxes"
  end
  # resource path
  local_var_path = '/bulk/inboxes'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(ids) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkActionsControllerApi#bulk_delete_inboxes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
bulk_send_emails(bulk_send_email_options, opts = {}) click to toggle source

Bulk Send Emails @param bulk_send_email_options [BulkSendEmailOptions] bulkSendEmailOptions @param [Hash] opts the optional parameters @return [nil]

# File lib/mailslurp_client/api/bulk_actions_controller_api.rb, line 147
def bulk_send_emails(bulk_send_email_options, opts = {})
  bulk_send_emails_with_http_info(bulk_send_email_options, opts)
  nil
end
bulk_send_emails_with_http_info(bulk_send_email_options, opts = {}) click to toggle source

Bulk Send Emails @param bulk_send_email_options [BulkSendEmailOptions] bulkSendEmailOptions @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/mailslurp_client/api/bulk_actions_controller_api.rb, line 156
def bulk_send_emails_with_http_info(bulk_send_email_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BulkActionsControllerApi.bulk_send_emails ...'
  end
  # verify the required parameter 'bulk_send_email_options' is set
  if @api_client.config.client_side_validation && bulk_send_email_options.nil?
    fail ArgumentError, "Missing the required parameter 'bulk_send_email_options' when calling BulkActionsControllerApi.bulk_send_emails"
  end
  # resource path
  local_var_path = '/bulk/send'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(bulk_send_email_options) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkActionsControllerApi#bulk_send_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end