Class: OsunyApi::UniversityOrganizationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/osuny_api/api/university_organization_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UniversityOrganizationApi

Returns a new instance of UniversityOrganizationApi.



16
17
18
 
# File 'lib/osuny_api/api/university_organization_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/osuny_api/api/university_organization_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#university_organizations_get(opts = {}) ⇒ Array<UniversityOrganization>

Lists organizations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_num (Integer) —

    Page number (default to 1)

  • :per_page (Integer) —

    Number of items per page (default to 10000)

Returns:



24
25
26
27
 
# File 'lib/osuny_api/api/university_organization_api.rb', line 24

def university_organizations_get(opts = {})
  data, _status_code, _headers = university_organizations_get_with_http_info(opts)
  data
end

#university_organizations_get_with_http_info(opts = {}) ⇒ Array<(Array<UniversityOrganization>, Integer, Hash)>

Lists organizations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_num (Integer) —

    Page number

  • :per_page (Integer) —

    Number of items per page

Returns:

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

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



34
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
 
# File 'lib/osuny_api/api/university_organization_api.rb', line 34

def university_organizations_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UniversityOrganizationApi.university_organizations_get ...'
  end
  # resource path
  local_var_path = '/university/organizations'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page_num'] = opts[:'page_num'] if !opts[:'page_num'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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[:body] 

  return_type = opts[:return_type] || 'Array<UniversityOrganization>' 

  auth_names = opts[:auth_names] || ['api_key']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UniversityOrganizationApi#university_organizations_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#university_organizations_id_delete(id, opts = {}) ⇒ nil

Deletes an organization

Parameters:

  • id —

    Organization identifier

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

    the optional parameters

Returns:

  • (nil) 


77
78
79
80
 
# File 'lib/osuny_api/api/university_organization_api.rb', line 77

def university_organizations_id_delete(id, opts = {})
  university_organizations_id_delete_with_http_info(id, opts)
  nil
end

#university_organizations_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Deletes an organization

Parameters:

  • id —

    Organization identifier

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
 
# File 'lib/osuny_api/api/university_organization_api.rb', line 86

def university_organizations_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UniversityOrganizationApi.university_organizations_id_delete ...'
  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 UniversityOrganizationApi.university_organizations_id_delete"
  end
  # resource path
  local_var_path = '/university/organizations/{id}'.sub('{' + 'id' + '}', id.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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_key']
  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,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UniversityOrganizationApi#university_organizations_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#university_organizations_id_get(id, opts = {}) ⇒ nil

Shows an organization

Parameters:

  • id —

    Organization identifier

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

    the optional parameters

Returns:

  • (nil) 


131
132
133
134
 
# File 'lib/osuny_api/api/university_organization_api.rb', line 131

def university_organizations_id_get(id, opts = {})
  university_organizations_id_get_with_http_info(id, opts)
  nil
end

#university_organizations_id_get_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Shows an organization

Parameters:

  • id —

    Organization identifier

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/osuny_api/api/university_organization_api.rb', line 140

def university_organizations_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UniversityOrganizationApi.university_organizations_id_get ...'
  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 UniversityOrganizationApi.university_organizations_id_get"
  end
  # resource path
  local_var_path = '/university/organizations/{id}'.sub('{' + 'id' + '}', id.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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_key']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UniversityOrganizationApi#university_organizations_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#university_organizations_id_patch(id, opts = {}) ⇒ nil

Updates an organization

Parameters:

  • id —

    Organization identifier

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


186
187
188
189
 
# File 'lib/osuny_api/api/university_organization_api.rb', line 186

def university_organizations_id_patch(id, opts = {})
  university_organizations_id_patch_with_http_info(id, opts)
  nil
end

#university_organizations_id_patch_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Updates an organization

Parameters:

  • id —

    Organization identifier

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/osuny_api/api/university_organization_api.rb', line 196

def university_organizations_id_patch_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UniversityOrganizationApi.university_organizations_id_patch ...'
  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 UniversityOrganizationApi.university_organizations_id_patch"
  end
  # resource path
  local_var_path = '/university/organizations/{id}'.sub('{' + 'id' + '}', id.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'])
  # 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(opts[:'body']) 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_key']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UniversityOrganizationApi#university_organizations_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#university_organizations_post(opts = {}) ⇒ nil

Creates a organization

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


243
244
245
246
 
# File 'lib/osuny_api/api/university_organization_api.rb', line 243

def university_organizations_post(opts = {})
  university_organizations_post_with_http_info(opts)
  nil
end

#university_organizations_post_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Creates a organization

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/osuny_api/api/university_organization_api.rb', line 252

def university_organizations_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UniversityOrganizationApi.university_organizations_post ...'
  end
  # resource path
  local_var_path = '/university/organizations'

  # 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'])
  # 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(opts[:'body']) 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_key']
  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,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UniversityOrganizationApi#university_organizations_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#university_organizations_upsert_post(opts = {}) ⇒ nil

Upsert organizations

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


295
296
297
298
 
# File 'lib/osuny_api/api/university_organization_api.rb', line 295

def university_organizations_upsert_post(opts = {})
  university_organizations_upsert_post_with_http_info(opts)
  nil
end

#university_organizations_upsert_post_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Upsert organizations

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/osuny_api/api/university_organization_api.rb', line 304

def university_organizations_upsert_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UniversityOrganizationApi.university_organizations_upsert_post ...'
  end
  # resource path
  local_var_path = '/university/organizations/upsert'

  # 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'])
  # 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(opts[:'body']) 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_key']
  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,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UniversityOrganizationApi#university_organizations_upsert_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end