Class: RadioManagerClient::PresenterApi

Inherits:
Object
  • Object
show all
Defined in:
lib/radiomanager_client/api/presenter_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PresenterApi

Returns a new instance of PresenterApi.



19
20
21
 
# File 'lib/radiomanager_client/api/presenter_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/radiomanager_client/api/presenter_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_presenter(data, opts = {}) ⇒ PostSuccess

Create presenter. Create presenter.

Parameters:

  • data —

    Data **(Required)**

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/radiomanager_client/api/presenter_api.rb', line 28

def create_presenter(data, opts = {})
  data, _status_code, _headers = create_presenter_with_http_info(data, opts)
  return data
end

#create_presenter_with_http_info(data, opts = {}) ⇒ Array<(PostSuccess, Fixnum, Hash)>

Create presenter. Create presenter.

Parameters:

  • data —

    Data **(Required)**

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

    the optional parameters

Returns:

  • (Array<(PostSuccess, Fixnum, Hash)>) —

    PostSuccess data, response status code and response headers



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
 
# File 'lib/radiomanager_client/api/presenter_api.rb', line 38

def create_presenter_with_http_info(data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PresenterApi.create_presenter ..."
  end
  # verify the required parameter 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling PresenterApi.create_presenter"
  end
  # resource path
  local_var_path = "/presenters"

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(data)
  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 => 'PostSuccess')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PresenterApi#create_presenter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_presenter_by_id(id, opts = {}) ⇒ Success

Delete presenter by id Delete presenter by id

Parameters:

  • id —

    id of presenter

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

    the optional parameters

Returns:



83
84
85
86
 
# File 'lib/radiomanager_client/api/presenter_api.rb', line 83

def delete_presenter_by_id(id, opts = {})
  data, _status_code, _headers = delete_presenter_by_id_with_http_info(id, opts)
  return data
end

#delete_presenter_by_id_with_http_info(id, opts = {}) ⇒ Array<(Success, Fixnum, Hash)>

Delete presenter by id Delete presenter by id

Parameters:

  • id —

    id of presenter

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

    the optional parameters

Returns:

  • (Array<(Success, Fixnum, Hash)>) —

    Success data, response status code and response headers



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
131
132
133
134
135
 
# File 'lib/radiomanager_client/api/presenter_api.rb', line 93

def delete_presenter_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PresenterApi.delete_presenter_by_id ..."
  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 PresenterApi.delete_presenter_by_id"
  end
  if @api_client.config.client_side_validation && id < 0
    fail ArgumentError, 'invalid value for "id" when calling PresenterApi.delete_presenter_by_id, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = "/presenters/{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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

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

#get_presenter_by_id(id, opts = {}) ⇒ PresenterResult

Get presenter by id Get presenter by id

Parameters:

  • id —

    id of Presenter

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

    the optional parameters

Options Hash (opts):

  • :_external_station_id (Integer) —

    Query on a different (content providing) station *(Optional)*

Returns:



143
144
145
146
 
# File 'lib/radiomanager_client/api/presenter_api.rb', line 143

def get_presenter_by_id(id, opts = {})
  data, _status_code, _headers = get_presenter_by_id_with_http_info(id, opts)
  return data
end

#get_presenter_by_id_with_http_info(id, opts = {}) ⇒ Array<(PresenterResult, Fixnum, Hash)>

Get presenter by id Get presenter by id

Parameters:

  • id —

    id of Presenter

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

    the optional parameters

Options Hash (opts):

  • :_external_station_id (Integer) —

    Query on a different (content providing) station *(Optional)*

Returns:

  • (Array<(PresenterResult, Fixnum, Hash)>) —

    PresenterResult data, response status code and response headers



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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/radiomanager_client/api/presenter_api.rb', line 154

def get_presenter_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PresenterApi.get_presenter_by_id ..."
  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 PresenterApi.get_presenter_by_id"
  end
  if @api_client.config.client_side_validation && id < 0
    fail ArgumentError, 'invalid value for "id" when calling PresenterApi.get_presenter_by_id, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = "/presenters/{id}".sub('{' + 'id' + '}', id.to_s)

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

  # header parameters
  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 = {}

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

#list_presenters(opts = {}) ⇒ PresenterResults

Get all presenters. List all presenters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Current page *(Optional)*

  • :program_id (Integer) —

    Search on Program ID *(Optional)* &#x60;(Relation)&#x60;

  • :broadcast_id (Integer) —

    Search on Broadcast ID *(Optional)* &#x60;(Relation)&#x60;

  • :model_type_id (Integer) —

    Search on ModelType ID (Optional)

  • :limit (Integer) —

    Results per page *(Optional)*

  • :order_by (String) —

    Field to order the results *(Optional)*

  • :order_direction (String) —

    Direction of ordering *(Optional)*

  • :_external_station_id (Integer) —

    Query on a different (content providing) station *(Optional)*

Returns:



211
212
213
214
 
# File 'lib/radiomanager_client/api/presenter_api.rb', line 211

def list_presenters(opts = {})
  data, _status_code, _headers = list_presenters_with_http_info(opts)
  return data
end

#list_presenters_with_http_info(opts = {}) ⇒ Array<(PresenterResults, Fixnum, Hash)>

Get all presenters. List all presenters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Current page *(Optional)*

  • :program_id (Integer) —

    Search on Program ID *(Optional)* &#x60;(Relation)&#x60;

  • :broadcast_id (Integer) —

    Search on Broadcast ID *(Optional)* &#x60;(Relation)&#x60;

  • :model_type_id (Integer) —

    Search on ModelType ID (Optional)

  • :limit (Integer) —

    Results per page *(Optional)*

  • :order_by (String) —

    Field to order the results *(Optional)*

  • :order_direction (String) —

    Direction of ordering *(Optional)*

  • :_external_station_id (Integer) —

    Query on a different (content providing) station *(Optional)*

Returns:

  • (Array<(PresenterResults, Fixnum, Hash)>) —

    PresenterResults data, response status code and response headers



228
229
230
231
232
233
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
285
 
# File 'lib/radiomanager_client/api/presenter_api.rb', line 228

def list_presenters_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PresenterApi.list_presenters ..."
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling PresenterApi.list_presenters, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 50
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling PresenterApi.list_presenters, must be smaller than or equal to 50.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling PresenterApi.list_presenters, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && opts[:'order_direction'] && !['asc', 'desc'].include?(opts[:'order_direction'])
    fail ArgumentError, 'invalid value for "order_direction", must be one of asc, desc'
  end
  # resource path
  local_var_path = "/presenters"

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'program_id'] = opts[:'program_id'] if !opts[:'program_id'].nil?
  query_params[:'broadcast_id'] = opts[:'broadcast_id'] if !opts[:'broadcast_id'].nil?
  query_params[:'model_type_id'] = opts[:'model_type_id'] if !opts[:'model_type_id'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'order-by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order-direction'] = opts[:'order_direction'] if !opts[:'order_direction'].nil?
  query_params[:'_external_station_id'] = opts[:'_external_station_id'] if !opts[:'_external_station_id'].nil?

  # header parameters
  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 = {}

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

#update_presenter_by_id(id, opts = {}) ⇒ Success

Update presenter by id Update presenter by id

Parameters:

  • id —

    id of Presenter

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

    the optional parameters

Options Hash (opts):

Returns:



293
294
295
296
 
# File 'lib/radiomanager_client/api/presenter_api.rb', line 293

def update_presenter_by_id(id, opts = {})
  data, _status_code, _headers = update_presenter_by_id_with_http_info(id, opts)
  return data
end

#update_presenter_by_id_with_http_info(id, opts = {}) ⇒ Array<(Success, Fixnum, Hash)>

Update presenter by id Update presenter by id

Parameters:

  • id —

    id of Presenter

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Success, Fixnum, Hash)>) —

    Success data, 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
343
344
345
346
 
# File 'lib/radiomanager_client/api/presenter_api.rb', line 304

def update_presenter_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PresenterApi.update_presenter_by_id ..."
  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 PresenterApi.update_presenter_by_id"
  end
  if @api_client.config.client_side_validation && id < 0
    fail ArgumentError, 'invalid value for "id" when calling PresenterApi.update_presenter_by_id, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = "/presenters/{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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

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