Class: RadioManagerClient::BlockApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BlockApi

Returns a new instance of BlockApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_block_by_id(id, opts = {}) ⇒ BlockResult

Get block by id Get block by id

Parameters:

  • id —

    ID of Block **(Required)**

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

    the optional parameters

Options Hash (opts):

  • :_external_station_id (Integer) —

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

Returns:



29
30
31
32
 
# File 'lib/radiomanager_client/api/block_api.rb', line 29

def get_block_by_id(id, opts = {})
  data, _status_code, _headers = get_block_by_id_with_http_info(id, opts)
  return data
end

#get_block_by_id_with_http_info(id, opts = {}) ⇒ Array<(BlockResult, Fixnum, Hash)>

Get block by id Get block by id

Parameters:

  • id —

    ID of Block **(Required)**

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

    the optional parameters

Options Hash (opts):

  • :_external_station_id (Integer) —

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

Returns:

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

    BlockResult data, response status code and response headers



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
82
83
 
# File 'lib/radiomanager_client/api/block_api.rb', line 40

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

  # resource path
  local_var_path = "/blocks/{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 => 'BlockResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlockApi#get_block_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_current_block(opts = {}) ⇒ BlockResult

Get current Block Get current Block

Parameters:

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

    the optional parameters

Returns:



89
90
91
92
 
# File 'lib/radiomanager_client/api/block_api.rb', line 89

def get_current_block(opts = {})
  data, _status_code, _headers = get_current_block_with_http_info(opts)
  return data
end

#get_current_block_with_http_info(opts = {}) ⇒ Array<(BlockResult, Fixnum, Hash)>

Get current Block Get current Block

Parameters:

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

    the optional parameters

Returns:

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

    BlockResult data, response status code and response headers



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

def get_current_block_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlockApi.get_current_block ..."
  end
  # resource path
  local_var_path = "/blocks/current"

  # 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(: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 => 'BlockResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlockApi#get_current_block\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_next_block(opts = {}) ⇒ BlockResult

Get upcoming Block Get upcoming Block

Parameters:

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

    the optional parameters

Returns:



138
139
140
141
 
# File 'lib/radiomanager_client/api/block_api.rb', line 138

def get_next_block(opts = {})
  data, _status_code, _headers = get_next_block_with_http_info(opts)
  return data
end

#get_next_block_with_http_info(opts = {}) ⇒ Array<(BlockResult, Fixnum, Hash)>

Get upcoming Block Get upcoming Block

Parameters:

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

    the optional parameters

Returns:

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

    BlockResult data, response status code and response headers



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
181
 
# File 'lib/radiomanager_client/api/block_api.rb', line 147

def get_next_block_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlockApi.get_next_block ..."
  end
  # resource path
  local_var_path = "/blocks/next"

  # 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(: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 => 'BlockResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlockApi#get_next_block\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_blocks(opts = {}) ⇒ BlockResults

Get a list of all blocks currently in your station. Get a list of all blocks currently in your station. This feature supports pagination and will give a maximum of 50 blocks back.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Current page *(Optional)* (default to 1)

  • :broadcast_id (Integer) —

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

  • :item_id (Integer) —

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

  • :program_id (Integer) —

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

  • :start_min (DateTime) —

    Minimum start date *(Optional)*

  • :start_max (DateTime) —

    Maximum start date *(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:



197
198
199
200
 
# File 'lib/radiomanager_client/api/block_api.rb', line 197

def list_blocks(opts = {})
  data, _status_code, _headers = list_blocks_with_http_info(opts)
  return data
end

#list_blocks_with_http_info(opts = {}) ⇒ Array<(BlockResults, Fixnum, Hash)>

Get a list of all blocks currently in your station. Get a list of all blocks currently in your station. This feature supports pagination and will give a maximum of 50 blocks back.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Current page *(Optional)*

  • :broadcast_id (Integer) —

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

  • :item_id (Integer) —

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

  • :program_id (Integer) —

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

  • :start_min (DateTime) —

    Minimum start date *(Optional)*

  • :start_max (DateTime) —

    Maximum start date *(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<(BlockResults, Fixnum, Hash)>) —

    BlockResults data, response status code and response headers



216
217
218
219
220
221
222
223
224
225
226
227
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
 
# File 'lib/radiomanager_client/api/block_api.rb', line 216

def list_blocks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlockApi.list_blocks ..."
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling BlockApi.list_blocks, 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 BlockApi.list_blocks, 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 BlockApi.list_blocks, 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 = "/blocks"

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'broadcast_id'] = opts[:'broadcast_id'] if !opts[:'broadcast_id'].nil?
  query_params[:'item_id'] = opts[:'item_id'] if !opts[:'item_id'].nil?
  query_params[:'program_id'] = opts[:'program_id'] if !opts[:'program_id'].nil?
  query_params[:'start-min'] = opts[:'start_min'] if !opts[:'start_min'].nil?
  query_params[:'start-max'] = opts[:'start_max'] if !opts[:'start_max'].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 => 'BlockResults')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlockApi#list_blocks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end