Class: CyberSource::ReportDownloadsApi
- Inherits:
-
Object
- Object
- CyberSource::ReportDownloadsApi
- Defined in:
- lib/cybersource_rest_client/api/report_downloads_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#download_report(report_date, report_name, opts = {}) ⇒ nil
Download a Report Download a report using the unique report name and date.
-
#download_report_with_http_info(report_date, report_name, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Download a Report Download a report using the unique report name and date.
-
#initialize(api_client = ApiClient.default, config) ⇒ ReportDownloadsApi
constructor
A new instance of ReportDownloadsApi.
Constructor Details
#initialize(api_client = ApiClient.default, config) ⇒ ReportDownloadsApi
Returns a new instance of ReportDownloadsApi.
19 20 21 22 |
# File 'lib/cybersource_rest_client/api/report_downloads_api.rb', line 19 def initialize(api_client = ApiClient.default, config) @api_client = api_client @api_client.set_configuration(config) end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/cybersource_rest_client/api/report_downloads_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#download_report(report_date, report_name, opts = {}) ⇒ nil
Download a Report Download a report using the unique report name and date.
32 33 34 35 |
# File 'lib/cybersource_rest_client/api/report_downloads_api.rb', line 32 def download_report(report_date, report_name, opts = {}) data, status_code, headers = download_report_with_http_info(report_date, report_name, opts) return data, status_code, headers end |
#download_report_with_http_info(report_date, report_name, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Download a Report Download a report using the unique report name and date.
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 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
# File 'lib/cybersource_rest_client/api/report_downloads_api.rb', line 44 def download_report_with_http_info(report_date, report_name, opts = {}) if @api_client.config.debugging begin raise @api_client.config.logger.debug 'Calling API: ReportDownloadsApi.download_report ...' rescue puts 'Cannot write to log' end end # verify the required parameter 'report_date' is set if @api_client.config.client_side_validation && report_date.nil? fail ArgumentError, "Missing the required parameter 'report_date' when calling ReportDownloadsApi.download_report" end # verify the required parameter 'report_name' is set if @api_client.config.client_side_validation && report_name.nil? fail ArgumentError, "Missing the required parameter 'report_name' when calling ReportDownloadsApi.download_report" end #if @api_client.config.client_side_validation && !opts[:'organization_id'].nil? && opts[:'organization_id'] !~ Regexp.new(/[a-zA-Z0-9-_]+/) #fail ArgumentError, "invalid value for 'opts[:\"organization_id\"]' when calling ReportDownloadsApi.download_report, must conform to the pattern /[a-zA-Z0-9-_]+/." #end # resource path local_var_path = 'reporting/v3/report-downloads' # query parameters query_params = {} query_params[:'reportDate'] = report_date query_params[:'reportName'] = report_name query_params[:'organizationId'] = opts[:'organization_id'] if !opts[:'organization_id'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/xml', 'text/csv']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8']) # form parameters form_params = {} # http body (model) if 'GET' == 'POST' post_body = '{}' else post_body = nil end auth_names = [] 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) if @api_client.config.debugging begin raise @api_client.config.logger.debug "API called: ReportDownloadsApi#download_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" rescue puts 'Cannot write to log' end end return data, status_code, headers end |