class Clever::EventsApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

get_event(id, opts = {}) click to toggle source

Returns the specific event @param id @param [Hash] opts the optional parameters @return [EventResponse]

# File lib/clever-ruby/api/events_api.rb, line 26
def get_event(id, opts = {})
  data, _status_code, _headers = get_event_with_http_info(id, opts)
  data
end
get_event_with_http_info(id, opts = {}) click to toggle source

Returns the specific event @param id @param [Hash] opts the optional parameters @return [Array<(EventResponse, Fixnum, Hash)>] EventResponse data, response status code and response headers

# File lib/clever-ruby/api/events_api.rb, line 35
def get_event_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.get_event ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling EventsApi.get_event"
  end
  # resource path
  local_var_path = '/events/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth']
  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 => 'EventResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EventsApi#get_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_events(opts = {}) click to toggle source

Returns a list of events @param [Hash] opts the optional parameters @option opts [Integer] :limit @option opts [String] :starting_after @option opts [String] :ending_before @option opts [String] :school @option opts [Array<String>] :record_type @return [EventsResponse]

# File lib/clever-ruby/api/events_api.rb, line 80
def get_events(opts = {})
  data, _status_code, _headers = get_events_with_http_info(opts)
  data
end
get_events_with_http_info(opts = {}) click to toggle source

Returns a list of events @param [Hash] opts the optional parameters @option opts [Integer] :limit @option opts [String] :starting_after @option opts [String] :ending_before @option opts [String] :school @option opts [Array<String>] :record_type @return [Array<(EventsResponse, Fixnum, Hash)>] EventsResponse data, response status code and response headers

# File lib/clever-ruby/api/events_api.rb, line 93
def get_events_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.get_events ...'
  end
  # resource path
  local_var_path = '/events'

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?
  query_params[:'school'] = opts[:'school'] if !opts[:'school'].nil?
  query_params[:'record_type'] = @api_client.build_collection_param(opts[:'record_type'], :multi) if !opts[:'record_type'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth']
  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 => 'EventsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EventsApi#get_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end