=begin #Bandwidth #Bandwidth's Communication APIs The version of the OpenAPI document: 1.0.0 Contact: letstalk@bandwidth.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.4.0 =end require 'cgi' module Bandwidth class MediaApi attr_accessor :api_client def initialize(api_client = ApiClient.default) @api_client = api_client end # 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. # @param account_id [String] Your Bandwidth Account ID. # @param media_id [String] Media ID to retrieve. # @param [Hash] opts the optional parameters # @return [nil] def delete_media(account_id, media_id, opts = {}) delete_media_with_http_info(account_id, media_id, opts) nil end # 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. # @param account_id [String] Your Bandwidth Account ID. # @param media_id [String] Media ID to retrieve. # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers def delete_media_with_http_info(account_id, 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 && account_id.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(account_id.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']) # 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 # Downloads a media file you previously uploaded. # @param account_id [String] Your Bandwidth Account ID. # @param media_id [String] Media ID to retrieve. # @param [Hash] opts the optional parameters # @return [File] def get_media(account_id, media_id, opts = {}) data, _status_code, _headers = get_media_with_http_info(account_id, media_id, opts) data end # Get Media # Downloads a media file you previously uploaded. # @param account_id [String] Your Bandwidth Account ID. # @param media_id [String] Media ID to retrieve. # @param [Hash] opts the optional parameters # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers def get_media_with_http_info(account_id, 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 && account_id.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(account_id.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']) # 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 # Gets a list of your media files. No query parameters are supported. # @param account_id [String] Your Bandwidth Account ID. # @param [Hash] opts the optional parameters # @option opts [String] :continuation_token Continuation token used to retrieve subsequent media. # @return [Array] def list_media(account_id, opts = {}) data, _status_code, _headers = list_media_with_http_info(account_id, opts) data end # List Media # Gets a list of your media files. No query parameters are supported. # @param account_id [String] Your Bandwidth Account ID. # @param [Hash] opts the optional parameters # @option opts [String] :continuation_token Continuation token used to retrieve subsequent media. # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers def list_media_with_http_info(account_id, 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 && account_id.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(account_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']) 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' # 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 # 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](https://support.bandwidth.com/hc/en-us/articles/360014128994-What-MMS-file-types-are-supported-). # @param account_id [String] Your Bandwidth Account ID. # @param media_id [String] Media ID to retrieve. # @param body [File] # @param [Hash] opts the optional parameters # @option opts [String] :content_type The media type of the entity-body. # @option opts [String] :cache_control General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. # @return [nil] def upload_media(account_id, media_id, body, opts = {}) upload_media_with_http_info(account_id, media_id, body, opts) nil end # 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](https://support.bandwidth.com/hc/en-us/articles/360014128994-What-MMS-file-types-are-supported-). # @param account_id [String] Your Bandwidth Account ID. # @param media_id [String] Media ID to retrieve. # @param body [File] # @param [Hash] opts the optional parameters # @option opts [String] :content_type The media type of the entity-body. # @option opts [String] :cache_control General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers def upload_media_with_http_info(account_id, 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 && account_id.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(account_id.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']) # 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 end end