Class: CyberSource::ReportDefinitionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/api/report_definitions_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default, config) ⇒ ReportDefinitionsApi

Returns a new instance of ReportDefinitionsApi.



19
20
21
22
 
# File 'lib/cybersource_rest_client/api/report_definitions_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_definitions_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_resource_info_by_report_definition(report_definition_name, opts = {}) ⇒ ReportingV3ReportDefinitionsNameGet200Response

Get a single report definition information The report definition name must be used as path parameter exclusive of each other

Parameters:

  • report_definition_name —

    Name of the Report definition to retrieve

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String) —

    Valid Cybersource Organization Id

Returns:



29
30
31
32
 
# File 'lib/cybersource_rest_client/api/report_definitions_api.rb', line 29

def get_resource_info_by_report_definition(report_definition_name, opts = {})
  data, _status_code, _headers = get_resource_info_by_report_definition_with_http_info(report_definition_name, opts)
  return data, _status_code, _headers
end

#get_resource_info_by_report_definition_with_http_info(report_definition_name, opts = {}) ⇒ Array<(ReportingV3ReportDefinitionsNameGet200Response, Fixnum, Hash)>

Get a single report definition information The report definition name must be used as path parameter exclusive of each other

Parameters:

  • report_definition_name —

    Name of the Report definition to retrieve

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String) —

    Valid Cybersource Organization Id

Returns:



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/cybersource_rest_client/api/report_definitions_api.rb', line 40

def get_resource_info_by_report_definition_with_http_info(report_definition_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportDefinitionsApi.get_resource_info_by_report_definition ...'
  end
  # verify the required parameter 'report_definition_name' is set
  if @api_client.config.client_side_validation && report_definition_name.nil?
    fail ArgumentError, "Missing the required parameter 'report_definition_name' when calling ReportDefinitionsApi.get_resource_info_by_report_definition"
  end
  if @api_client.config.client_side_validation && !opts[:'organization_id'].nil? && opts[:'organization_id'].to_s.length > 32
    fail ArgumentError, 'invalid value for "opts[:"organization_id"]" when calling ReportDefinitionsApi.get_resource_info_by_report_definition, the character length must be smaller than or equal to 32.'
  end

  if @api_client.config.client_side_validation && !opts[:'organization_id'].nil? && opts[:'organization_id'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"organization_id"]" when calling ReportDefinitionsApi.get_resource_info_by_report_definition, the character length must be great than or equal to 1.'
  end
  # resource path
  local_var_path = 'reporting/v3/report-definitions/{reportDefinitionName}'.sub('{' + 'reportDefinitionName' + '}', report_definition_name.to_s)

  # query parameters
  query_params = {}
  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/hal+json'])
  # 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)
  post_body = nil
  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,
    :return_type => 'ReportingV3ReportDefinitionsNameGet200Response')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportDefinitionsApi#get_resource_info_by_report_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_resource_v2_info(opts = {}) ⇒ ReportingV3ReportDefinitionsGet200Response

Get reporting resource information

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String) —

    Valid Cybersource Organization Id

Returns:



92
93
94
95
 
# File 'lib/cybersource_rest_client/api/report_definitions_api.rb', line 92

def get_resource_v2_info(opts = {})
  data, _status_code, _headers = get_resource_v2_info_with_http_info(opts)
  return data, _status_code, _headers
end

#get_resource_v2_info_with_http_info(opts = {}) ⇒ Array<(ReportingV3ReportDefinitionsGet200Response, Fixnum, Hash)>

Get reporting resource information

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String) —

    Valid Cybersource Organization Id

Returns:



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
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/cybersource_rest_client/api/report_definitions_api.rb', line 102

def get_resource_v2_info_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportDefinitionsApi.get_resource_v2_info ...'
  end
  if @api_client.config.client_side_validation && !opts[:'organization_id'].nil? && opts[:'organization_id'].to_s.length > 32
    fail ArgumentError, 'invalid value for "opts[:"organization_id"]" when calling ReportDefinitionsApi.get_resource_v2_info, the character length must be smaller than or equal to 32.'
  end

  if @api_client.config.client_side_validation && !opts[:'organization_id'].nil? && opts[:'organization_id'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"organization_id"]" when calling ReportDefinitionsApi.get_resource_v2_info, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = 'reporting/v3/report-definitions'

  # query parameters
  query_params = {}
  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/hal+json'])
  # 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)
  post_body = nil
  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,
    :return_type => 'ReportingV3ReportDefinitionsGet200Response')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportDefinitionsApi#get_resource_v2_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end