Class: SendX::ReportsApi
- Inherits:
-
Object
- Object
- SendX::ReportsApi
- Defined in:
- lib/sendx-ruby-sdk/api/reports_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#get_campaign_report(campaign_id, opts = {}) ⇒ ReportData
Get CampaignReport Data Retrieve the campaign report data based on the provided campaign id.
-
#get_campaign_report_with_http_info(campaign_id, opts = {}) ⇒ Array<(ReportData, Integer, Hash)>
Get CampaignReport Data Retrieve the campaign report data based on the provided campaign id.
-
#initialize(api_client = ApiClient.default) ⇒ ReportsApi
constructor
A new instance of ReportsApi.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ ReportsApi
Returns a new instance of ReportsApi.
19 20 21 |
# File 'lib/sendx-ruby-sdk/api/reports_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/sendx-ruby-sdk/api/reports_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#get_campaign_report(campaign_id, opts = {}) ⇒ ReportData
Get CampaignReport Data Retrieve the campaign report data based on the provided campaign id.
28 29 30 31 |
# File 'lib/sendx-ruby-sdk/api/reports_api.rb', line 28 def get_campaign_report(campaign_id, opts = {}) data, _status_code, _headers = get_campaign_report_with_http_info(campaign_id, opts) data end |
#get_campaign_report_with_http_info(campaign_id, opts = {}) ⇒ Array<(ReportData, Integer, Hash)>
Get CampaignReport Data Retrieve the campaign report data based on the provided campaign id.
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 |
# File 'lib/sendx-ruby-sdk/api/reports_api.rb', line 39 def get_campaign_report_with_http_info(campaign_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ReportsApi.get_campaign_report ...' end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ReportsApi.get_campaign_report" end # resource path local_var_path = '/report/campaign/{campaignId}'.sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'integrationType'] = opts[:'integration_type'] if !opts[:'integration_type'].nil? # 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] || 'ReportData' # auth_names auth_names = opts[:debug_auth_names] || ['apiKeyAuth'] = opts.merge( :operation => :"ReportsApi.get_campaign_report", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ReportsApi#get_campaign_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |