Class: School21::ClustersApi

Inherits:
BaseApi
  • Object
show all
Defined in:
lib/school21/api/clusters_api.rb

Constant Summary

Constants inherited from BaseApi

BaseApi::PLATFORM_AUTH_PARTICIPANT

Instance Method Summary collapse

Methods inherited from BaseApi

base_uri, #execute_request, #initialize, #new_api_call_builder, #new_parameter, #new_request_builder, #new_response_handler, #request_with_auth_participant, response_convertor

Constructor Details

This class inherits a constructor from School21::BaseApi

Instance Method Details

#map(cluster_id, options: {}) ⇒ Object



5
6
7
8
9
10
11
12
13
14
15
# File 'lib/school21/api/clusters_api.rb', line 5

def map(cluster_id, options: {})
  path = ['/clusters/', cluster_id, '/map'].join
  default_options = { limit: 50, offset: 0 }.merge(options)
  new_request = request_with_auth_participant(HttpMethod::GET, path, :api_v1)

  default_options.each do |key, value|
    new_request.query_param(new_parameter(value, key:))
  end

  execute_request(new_request)
end