Class: FlatApi::GroupApi

Inherits:
Object
  • Object
show all
Defined in:
lib/flat_api/api/group_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GroupApi

Returns a new instance of GroupApi.



19
20
21
 
# File 'lib/flat_api/api/group_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/flat_api/api/group_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_group_details(group, opts = {}) ⇒ GroupDetails

Get group information

Parameters:

  • group (String) —

    Unique identifier of a Flat group

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/flat_api/api/group_api.rb', line 26

def get_group_details(group, opts = {})
  data, _status_code, _headers = get_group_details_with_http_info(group, opts)
  data
end

#get_group_details_with_http_info(group, opts = {}) ⇒ Array<(GroupDetails, Integer, Hash)>

Get group information

Parameters:

  • group (String) —

    Unique identifier of a Flat group

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GroupDetails, Integer, Hash)>) —

    GroupDetails data, response status code and response headers



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/flat_api/api/group_api.rb', line 35

def get_group_details_with_http_info(group, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupApi.get_group_details ...'
  end
  # verify the required parameter 'group' is set
  if @api_client.config.client_side_validation && group.nil?
    fail ArgumentError, "Missing the required parameter 'group' when calling GroupApi.get_group_details"
  end
  # resource path
  local_var_path = '/groups/{group}'.sub('{' + 'group' + '}', CGI.escape(group.to_s))

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

  # 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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GroupDetails'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2']

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

#get_group_scores(group, opts = {}) ⇒ Array<ScoreDetails>

List group’s scores Get the list of scores shared with a group.

Parameters:

  • group (String) —

    Unique identifier of a Flat group

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :parent (String) —

    Filter the score forked from the score id &#x60;parent&#x60;

Returns:



89
90
91
92
 
# File 'lib/flat_api/api/group_api.rb', line 89

def get_group_scores(group, opts = {})
  data, _status_code, _headers = get_group_scores_with_http_info(group, opts)
  data
end

#get_group_scores_with_http_info(group, opts = {}) ⇒ Array<(Array<ScoreDetails>, Integer, Hash)>

List group&#39;s scores Get the list of scores shared with a group.

Parameters:

  • group (String) —

    Unique identifier of a Flat group

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :parent (String) —

    Filter the score forked from the score id &#x60;parent&#x60;

Returns:

  • (Array<(Array<ScoreDetails>, Integer, Hash)>) —

    Array<ScoreDetails> data, response status code and response headers



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/flat_api/api/group_api.rb', line 100

def get_group_scores_with_http_info(group, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupApi.get_group_scores ...'
  end
  # verify the required parameter 'group' is set
  if @api_client.config.client_side_validation && group.nil?
    fail ArgumentError, "Missing the required parameter 'group' when calling GroupApi.get_group_scores"
  end
  # resource path
  local_var_path = '/groups/{group}/scores'.sub('{' + 'group' + '}', CGI.escape(group.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'parent'] = opts[:'parent'] if !opts[:'parent'].nil?

  # 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[:debug_body]

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2']

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

#list_group_users(group, opts = {}) ⇒ Array<UserPublic>

List group’s users

Parameters:

  • group (String) —

    Unique identifier of a Flat group

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :source (String) —

    Filter the users by their source

Returns:



154
155
156
157
 
# File 'lib/flat_api/api/group_api.rb', line 154

def list_group_users(group, opts = {})
  data, _status_code, _headers = list_group_users_with_http_info(group, opts)
  data
end

#list_group_users_with_http_info(group, opts = {}) ⇒ Array<(Array<UserPublic>, Integer, Hash)>

List group&#39;s users

Parameters:

  • group (String) —

    Unique identifier of a Flat group

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :source (String) —

    Filter the users by their source

Returns:

  • (Array<(Array<UserPublic>, Integer, Hash)>) —

    Array<UserPublic> data, response status code and response headers



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/flat_api/api/group_api.rb', line 164

def list_group_users_with_http_info(group, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupApi.list_group_users ...'
  end
  # verify the required parameter 'group' is set
  if @api_client.config.client_side_validation && group.nil?
    fail ArgumentError, "Missing the required parameter 'group' when calling GroupApi.list_group_users"
  end
  allowable_values = ["googleClassroom", "microsoftGraph", "clever"]
  if @api_client.config.client_side_validation && opts[:'source'] && !allowable_values.include?(opts[:'source'])
    fail ArgumentError, "invalid value for \"source\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/groups/{group}/users'.sub('{' + 'group' + '}', CGI.escape(group.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?

  # 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[:debug_body]

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2']

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