Class: Bandwidth::MediaApi

Inherits:
Object
  • Object
show all
Defined in:
lib/bandwidth-sdk/api/media_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MediaApi

Returns a new instance of MediaApi.



19
20
21
 
# File 'lib/bandwidth-sdk/api/media_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/bandwidth-sdk/api/media_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_media(account_id, media_id, opts = {}) ⇒ nil

Delete Media Deletes a media file from Bandwidth API server. Make sure you don’t have any application scripts still using the media before you delete. If you accidentally delete a media file you can immediately upload a new file with the same name.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • media_id (String) —

    Media ID to retrieve.

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

    the optional parameters

Returns:

  • (nil) 


28
29
30
31
 
# File 'lib/bandwidth-sdk/api/media_api.rb', line 28

def delete_media(, media_id, opts = {})
  delete_media_with_http_info(, media_id, opts)
  nil
end

#delete_media_with_http_info(account_id, media_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Media Deletes a media file from Bandwidth API server. Make sure you don&#39;t have any application scripts still using the media before you delete. If you accidentally delete a media file you can immediately upload a new file with the same name.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • media_id (String) —

    Media ID to retrieve.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
82
83
84
85
86
87
88
89
 
# File 'lib/bandwidth-sdk/api/media_api.rb', line 39

def delete_media_with_http_info(, media_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MediaApi.delete_media ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling MediaApi.delete_media"
  end
  # verify the required parameter 'media_id' is set
  if @api_client.config.client_side_validation && media_id.nil?
    fail ArgumentError, "Missing the required parameter 'media_id' when calling MediaApi.delete_media"
  end
  # resource path
  local_var_path = '/users/{accountId}/media/{mediaId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'mediaId' + '}', CGI.escape(media_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']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

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

#get_media(account_id, media_id, opts = {}) ⇒ File

Get Media Downloads a media file you previously uploaded.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • media_id (String) —

    Media ID to retrieve.

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

    the optional parameters

Returns:

  • (File) 


97
98
99
100
 
# File 'lib/bandwidth-sdk/api/media_api.rb', line 97

def get_media(, media_id, opts = {})
  data, _status_code, _headers = get_media_with_http_info(, media_id, opts)
  data
end

#get_media_with_http_info(account_id, media_id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Get Media Downloads a media file you previously uploaded.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • media_id (String) —

    Media ID to retrieve.

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

    the optional parameters

Returns:

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

    File data, response status code and response headers



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
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/bandwidth-sdk/api/media_api.rb', line 108

def get_media_with_http_info(, media_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MediaApi.get_media ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling MediaApi.get_media"
  end
  # verify the required parameter 'media_id' is set
  if @api_client.config.client_side_validation && media_id.nil?
    fail ArgumentError, "Missing the required parameter 'media_id' when calling MediaApi.get_media"
  end
  # resource path
  local_var_path = '/users/{accountId}/media/{mediaId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'mediaId' + '}', CGI.escape(media_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/octet-stream', 'application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"MediaApi.get_media",
    :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: MediaApi#get_media\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_media(account_id, opts = {}) ⇒ Array<Media>

List Media Gets a list of your media files. No query parameters are supported.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

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

    the optional parameters

Options Hash (opts):

  • :continuation_token (String) —

    Continuation token used to retrieve subsequent media.

Returns:



166
167
168
169
 
# File 'lib/bandwidth-sdk/api/media_api.rb', line 166

def list_media(, opts = {})
  data, _status_code, _headers = list_media_with_http_info(, opts)
  data
end

#list_media_with_http_info(account_id, opts = {}) ⇒ Array<(Array<Media>, Integer, Hash)>

List Media Gets a list of your media files. No query parameters are supported.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

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

    the optional parameters

Options Hash (opts):

  • :continuation_token (String) —

    Continuation token used to retrieve subsequent media.

Returns:

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

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



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
216
217
218
219
220
221
222
223
224
 
# File 'lib/bandwidth-sdk/api/media_api.rb', line 177

def list_media_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MediaApi.list_media ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling MediaApi.list_media"
  end
  # resource path
  local_var_path = '/users/{accountId}/media'.sub('{' + 'accountId' + '}', CGI.escape(.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']) unless header_params['Accept']
  header_params[:'Continuation-Token'] = opts[:'continuation_token'] if !opts[:'continuation_token'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"MediaApi.list_media",
    :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: MediaApi#list_media\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upload_media(account_id, media_id, body, opts = {}) ⇒ nil

Upload Media Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found [here](support.bandwidth.com/hc/en-us/articles/360014128994-What-MMS-file-types-are-supported-).

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • media_id (String) —

    Media ID to retrieve.

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

    the optional parameters

Options Hash (opts):

  • :content_type (String) —

    The media type of the entity-body.

  • :cache_control (String) —

    General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.

Returns:

  • (nil) 


235
236
237
238
 
# File 'lib/bandwidth-sdk/api/media_api.rb', line 235

def upload_media(, media_id, body, opts = {})
  upload_media_with_http_info(, media_id, body, opts)
  nil
end

#upload_media_with_http_info(account_id, media_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Upload Media Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found [here](support.bandwidth.com/hc/en-us/articles/360014128994-What-MMS-file-types-are-supported-).

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • media_id (String) —

    Media ID to retrieve.

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

    the optional parameters

Options Hash (opts):

  • :content_type (String) —

    The media type of the entity-body.

  • :cache_control (String) —

    General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.

Returns:

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

    nil, response status code and response headers



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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/bandwidth-sdk/api/media_api.rb', line 249

def upload_media_with_http_info(, media_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MediaApi.upload_media ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling MediaApi.upload_media"
  end
  # verify the required parameter 'media_id' is set
  if @api_client.config.client_side_validation && media_id.nil?
    fail ArgumentError, "Missing the required parameter 'media_id' when calling MediaApi.upload_media"
  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 MediaApi.upload_media"
  end
  # resource path
  local_var_path = '/users/{accountId}/media/{mediaId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'mediaId' + '}', CGI.escape(media_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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/ogg', 'application/pdf', 'application/rtf', 'application/zip', 'application/x-tar', 'application/xml', 'application/gzip', 'application/x-bzip2', 'application/x-gzip', 'application/smil', 'application/javascript', 'audio/mp4', 'audio/mpeg', 'audio/ogg', 'audio/flac', 'audio/webm', 'audio/wav', 'audio/amr', 'audio/3gpp', 'image/bmp', 'image/gif', 'image/jpeg', 'image/pjpeg', 'image/png', 'image/svg+xml', 'image/tiff', 'image/webp', 'image/x-icon', 'text/css', 'text/csv', 'text/calendar', 'text/plain', 'text/javascript', 'text/vcard', 'text/vnd.wap.wml', 'text/xml', 'video/avi', 'video/mp4', 'video/mpeg', 'video/ogg', 'video/quicktime', 'video/webm', 'video/x-ms-wmv'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'Content-Type'] = opts[:'content_type'] if !opts[:'content_type'].nil?
  header_params[:'Cache-Control'] = opts[:'cache_control'] if !opts[:'cache_control'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type]

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

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