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 Report Definition View the attributes of an individual report type. For a list of values for reportDefinitionName, see the [Reporting Developer Guide](www.cybersource.com/developers/documentation/reporting_and_reconciliation/)

Parameters:

  • report_definition_name —

    Name of the Report definition to retrieve

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

    the optional parameters

Options Hash (opts):

  • :subscription_type (String) —

    The subscription type for which report definition is required. By default the type will be CUSTOM. Valid Values: - CLASSIC - CUSTOM - STANDARD

  • :report_mime_type (String) —

    The format for which the report definition is required. By default the value will be CSV. Valid Values: - application/xml - text/csv

  • :organization_id (String) —

    Valid Organization Id

Returns:



31
32
33
34
 
# File 'lib/cybersource_rest_client/api/report_definitions_api.rb', line 31

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 Report Definition View the attributes of an individual report type. For a list of values for reportDefinitionName, see the [Reporting Developer Guide](www.cybersource.com/developers/documentation/reporting_and_reconciliation/)

Parameters:

  • report_definition_name —

    Name of the Report definition to retrieve

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

    the optional parameters

Options Hash (opts):

  • :subscription_type (String) —

    The subscription type for which report definition is required. By default the type will be CUSTOM. Valid Values: - CLASSIC - CUSTOM - STANDARD

  • :report_mime_type (String) —

    The format for which the report definition is required. By default the value will be CSV. Valid Values: - application/xml - text/csv

  • :organization_id (String) —

    Valid Organization Id

Returns:



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
108
 
# File 'lib/cybersource_rest_client/api/report_definitions_api.rb', line 44

def get_resource_info_by_report_definition_with_http_info(report_definition_name, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: ReportDefinitionsApi.get_resource_info_by_report_definition ...'
        rescue
            puts 'Cannot write to log'
        end
  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

  #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 ReportDefinitionsApi.get_resource_info_by_report_definition, must conform to the pattern /[a-zA-Z0-9-_]+/."
  #end

  # resource path
  local_var_path = 'reporting/v3/report-definitions/{reportDefinitionName}'.sub('{' + 'reportDefinitionName' + '}', report_definition_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'subscriptionType'] = opts[:'subscription_type'] if !opts[:'subscription_type'].nil?
  query_params[:'reportMimeType'] = opts[:'report_mime_type'] if !opts[:'report_mime_type'].nil?
  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
    begin
    raise
        @api_client.config.logger.debug "API called: ReportDefinitionsApi#get_resource_info_by_report_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#get_resource_v2_info(opts = {}) ⇒ ReportingV3ReportDefinitionsGet200Response

Get Reporting Resource Information View a list of supported reports and their attributes before subscribing to them.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :subscription_type (String) —

    Valid Values: - CLASSIC - CUSTOM - STANDARD

  • :organization_id (String) —

    Valid Organization Id

Returns:



115
116
117
118
 
# File 'lib/cybersource_rest_client/api/report_definitions_api.rb', line 115

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 View a list of supported reports and their attributes before subscribing to them.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :subscription_type (String) —

    Valid Values: - CLASSIC - CUSTOM - STANDARD

  • :organization_id (String) —

    Valid Organization Id

Returns:



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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/cybersource_rest_client/api/report_definitions_api.rb', line 126

def get_resource_v2_info_with_http_info(opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: ReportDefinitionsApi.get_resource_v2_info ...'
        rescue
            puts 'Cannot write to log'
        end
  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

  #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 ReportDefinitionsApi.get_resource_v2_info, must conform to the pattern /[a-zA-Z0-9-_]+/."
  #end

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

  # query parameters
  query_params = {}
  query_params[:'subscriptionType'] = opts[:'subscription_type'] if !opts[:'subscription_type'].nil?
  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
    begin
    raise
        @api_client.config.logger.debug "API called: ReportDefinitionsApi#get_resource_v2_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end