Class: OneRosterClient::LineItemsManagementApi

Inherits:
Object
  • Object
show all
Defined in:
lib/oneroster_client/api/line_items_management_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LineItemsManagementApi

Returns a new instance of LineItemsManagementApi.



16
17
18
 
# File 'lib/oneroster_client/api/line_items_management_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/oneroster_client/api/line_items_management_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#delete_line_item(sourced_id, opts = {}) ⇒ nil

The REST delete request message for the deleteLineItem() API call. …not supplied…

Parameters:

  • sourced_id —

    …tbd…

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

    the optional parameters

Returns:

  • (nil) 


24
25
26
27
 
# File 'lib/oneroster_client/api/line_items_management_api.rb', line 24

def delete_line_item(sourced_id, opts = {})
  delete_line_item_with_http_info(sourced_id, opts)
  nil
end

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

The REST delete request message for the deleteLineItem() API call. …not supplied…

Parameters:

  • sourced_id —

    …tbd…

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

    the optional parameters

Returns:

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

    nil, 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
73
74
 
# File 'lib/oneroster_client/api/line_items_management_api.rb', line 34

def delete_line_item_with_http_info(sourced_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LineItemsManagementApi.delete_line_item ...'
  end
  # verify the required parameter 'sourced_id' is set
  if @api_client.config.client_side_validation && sourced_id.nil?
    fail ArgumentError, "Missing the required parameter 'sourced_id' when calling LineItemsManagementApi.delete_line_item"
  end
  # resource path
  local_var_path = '/lineItems/{sourcedId}'.sub('{' + 'sourcedId' + '}', sourced_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] || ['OAuth2Security']
  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: LineItemsManagementApi#delete_line_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_line_item(sourced_id, opts = {}) ⇒ SingleLineItemType

The REST read request message for the getLineItem() API call. …not supplied…

Parameters:

  • sourced_id —

    …tbd…

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

    the optional parameters

Returns:



80
81
82
83
 
# File 'lib/oneroster_client/api/line_items_management_api.rb', line 80

def get_line_item(sourced_id, opts = {})
  data, _status_code, _headers = get_line_item_with_http_info(sourced_id, opts)
  data
end

#get_line_item_with_http_info(sourced_id, opts = {}) ⇒ Array<(SingleLineItemType, Integer, Hash)>

The REST read request message for the getLineItem() API call. …not supplied…

Parameters:

  • sourced_id —

    …tbd…

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

    the optional parameters

Returns:

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

    SingleLineItemType data, response status code and response headers



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
127
128
129
130
 
# File 'lib/oneroster_client/api/line_items_management_api.rb', line 90

def get_line_item_with_http_info(sourced_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LineItemsManagementApi.get_line_item ...'
  end
  # verify the required parameter 'sourced_id' is set
  if @api_client.config.client_side_validation && sourced_id.nil?
    fail ArgumentError, "Missing the required parameter 'sourced_id' when calling LineItemsManagementApi.get_line_item"
  end
  # resource path
  local_var_path = '/lineItems/{sourcedId}'.sub('{' + 'sourcedId' + '}', sourced_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] || 'SingleLineItemType' 

  auth_names = opts[:auth_names] || ['OAuth2Security']
  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: LineItemsManagementApi#get_line_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_line_items(opts = {}) ⇒ LineItemsType

The REST read request message for the getLineItems() API call. …not supplied…

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    To define the download segmentation value i.e. the maximum number of records to be contained in the response. (default to 100)

  • :offset (Integer) —

    The number of the first record to be supplied in the segmented response message. (default to 0)

  • :continuation_token (String) —

    Allows the client to resume retrieving results from where the previous page left off

  • :sort (String) —

    Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.

  • :order_by (String) —

    The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).

  • :filter (String) —

    The filtering rules to be applied when identifying the records to be supplied in the response message.

  • :fields (Array<String>) —

    To identify the range of fields that should be supplied in the response message.

Returns:



142
143
144
145
 
# File 'lib/oneroster_client/api/line_items_management_api.rb', line 142

def get_line_items(opts = {})
  data, _status_code, _headers = get_line_items_with_http_info(opts)
  data
end

#get_line_items_for_class(class_sourced_id, opts = {}) ⇒ LineItemsType

The REST read request message for the getLineItemsForClass() API call. …not supplied…

Parameters:

  • class_sourced_id —

    …tbd…

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    To define the download segmentation value i.e. the maximum number of records to be contained in the response. (default to 100)

  • :offset (Integer) —

    The number of the first record to be supplied in the segmented response message. (default to 0)

  • :continuation_token (String) —

    Allows the client to resume retrieving results from where the previous page left off

  • :sort (String) —

    Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.

  • :order_by (String) —

    The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).

  • :filter (String) —

    The filtering rules to be applied when identifying the records to be supplied in the response message.

  • :fields (Array<String>) —

    To identify the range of fields that should be supplied in the response message.

Returns:



217
218
219
220
 
# File 'lib/oneroster_client/api/line_items_management_api.rb', line 217

def get_line_items_for_class(class_sourced_id, opts = {})
  data, _status_code, _headers = get_line_items_for_class_with_http_info(class_sourced_id, opts)
  data
end

#get_line_items_for_class_with_http_info(class_sourced_id, opts = {}) ⇒ Array<(LineItemsType, Integer, Hash)>

The REST read request message for the getLineItemsForClass() API call. …not supplied…

Parameters:

  • class_sourced_id —

    …tbd…

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    To define the download segmentation value i.e. the maximum number of records to be contained in the response.

  • :offset (Integer) —

    The number of the first record to be supplied in the segmented response message.

  • :continuation_token (String) —

    Allows the client to resume retrieving results from where the previous page left off

  • :sort (String) —

    Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.

  • :order_by (String) —

    The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).

  • :filter (String) —

    The filtering rules to be applied when identifying the records to be supplied in the response message.

  • :fields (Array<String>) —

    To identify the range of fields that should be supplied in the response message.

Returns:

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

    LineItemsType data, response status code and response headers



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
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
 
# File 'lib/oneroster_client/api/line_items_management_api.rb', line 234

def get_line_items_for_class_with_http_info(class_sourced_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LineItemsManagementApi.get_line_items_for_class ...'
  end
  # verify the required parameter 'class_sourced_id' is set
  if @api_client.config.client_side_validation && class_sourced_id.nil?
    fail ArgumentError, "Missing the required parameter 'class_sourced_id' when calling LineItemsManagementApi.get_line_items_for_class"
  end
  if @api_client.config.client_side_validation && opts[:'order_by'] && !['acs', 'desc'].include?(opts[:'order_by'])
    fail ArgumentError, 'invalid value for "order_by", must be one of acs, desc'
  end
  # resource path
  local_var_path = '/classes/{classSourcedId}/lineItems'.sub('{' + 'classSourcedId' + '}', class_sourced_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'continuationToken'] = opts[:'continuation_token'] if !opts[:'continuation_token'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].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] || 'LineItemsType' 

  auth_names = opts[:auth_names] || ['OAuth2Security']
  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: LineItemsManagementApi#get_line_items_for_class\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_line_items_with_http_info(opts = {}) ⇒ Array<(LineItemsType, Integer, Hash)>

The REST read request message for the getLineItems() API call. …not supplied…

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    To define the download segmentation value i.e. the maximum number of records to be contained in the response.

  • :offset (Integer) —

    The number of the first record to be supplied in the segmented response message.

  • :continuation_token (String) —

    Allows the client to resume retrieving results from where the previous page left off

  • :sort (String) —

    Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.

  • :order_by (String) —

    The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).

  • :filter (String) —

    The filtering rules to be applied when identifying the records to be supplied in the response message.

  • :fields (Array<String>) —

    To identify the range of fields that should be supplied in the response message.

Returns:

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

    LineItemsType data, response status code and response headers



158
159
160
161
162
163
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
 
# File 'lib/oneroster_client/api/line_items_management_api.rb', line 158

def get_line_items_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LineItemsManagementApi.get_line_items ...'
  end
  if @api_client.config.client_side_validation && opts[:'order_by'] && !['acs', 'desc'].include?(opts[:'order_by'])
    fail ArgumentError, 'invalid value for "order_by", must be one of acs, desc'
  end
  # resource path
  local_var_path = '/lineItems'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'continuationToken'] = opts[:'continuation_token'] if !opts[:'continuation_token'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].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] || 'LineItemsType' 

  auth_names = opts[:auth_names] || ['OAuth2Security']
  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: LineItemsManagementApi#get_line_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_line_item(body, sourced_id, opts = {}) ⇒ nil

The REST create request message for the putLineItem() API call. …not supplied…

Parameters:

  • body —

    …tbd…

  • sourced_id —

    …tbd…

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

    the optional parameters

Returns:

  • (nil) 


291
292
293
294
 
# File 'lib/oneroster_client/api/line_items_management_api.rb', line 291

def put_line_item(body, sourced_id, opts = {})
  put_line_item_with_http_info(body, sourced_id, opts)
  nil
end

#put_line_item_with_http_info(body, sourced_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

The REST create request message for the putLineItem() API call. …not supplied…

Parameters:

  • body —

    …tbd…

  • sourced_id —

    …tbd…

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



302
303
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
343
344
345
346
347
348
 
# File 'lib/oneroster_client/api/line_items_management_api.rb', line 302

def put_line_item_with_http_info(body, sourced_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LineItemsManagementApi.put_line_item ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling LineItemsManagementApi.put_line_item"
  end
  # verify the required parameter 'sourced_id' is set
  if @api_client.config.client_side_validation && sourced_id.nil?
    fail ArgumentError, "Missing the required parameter 'sourced_id' when calling LineItemsManagementApi.put_line_item"
  end
  # resource path
  local_var_path = '/lineItems/{sourcedId}'.sub('{' + 'sourcedId' + '}', sourced_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(body) 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['OAuth2Security']
  data, status_code, headers = @api_client.call_api(:PUT, 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: LineItemsManagementApi#put_line_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end