Class: SubskribeSandboxClient::ReportsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/subskribe_sandbox/api/reports_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ReportsApi

Returns a new instance of ReportsApi.



19
20
21
 
# File 'lib/subskribe_sandbox/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/subskribe_sandbox/api/reports_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#generate(body, opts = {}) ⇒ ReportJobResponse

Generate a report Generates a report with the specified parameters. This report can later be downloaded via /reports/reportRunId/result

Parameters:

  • body —

    json definition of the report

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/subskribe_sandbox/api/reports_api.rb', line 27

def generate(body, opts = {})
  data, _status_code, _headers = generate_with_http_info(body, opts)
  data
end

#generate_with_http_info(body, opts = {}) ⇒ Array<(ReportJobResponse, Fixnum, Hash)>

Generate a report Generates a report with the specified parameters. This report can later be downloaded via /reports/reportRunId/result

Parameters:

  • body —

    json definition of the report

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

    the optional parameters

Returns:

  • (Array<(ReportJobResponse, Fixnum, Hash)>) —

    ReportJobResponse data, response status code and response headers



37
38
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
 
# File 'lib/subskribe_sandbox/api/reports_api.rb', line 37

def generate_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportsApi.generate ...'
  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 ReportsApi.generate"
  end
  # resource path
  local_var_path = '/reports/generate'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ReportJobResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportsApi#generate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_predefined_report_defs(opts = {}) ⇒ PredefinedReportDefsJson

Get report definitions Returns the definitions of the reports defined for your tenant.

Parameters:

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

    the optional parameters

Returns:



80
81
82
83
 
# File 'lib/subskribe_sandbox/api/reports_api.rb', line 80

def get_predefined_report_defs(opts = {})
  data, _status_code, _headers = get_predefined_report_defs_with_http_info(opts)
  data
end

#get_predefined_report_defs_with_http_info(opts = {}) ⇒ Array<(PredefinedReportDefsJson, Fixnum, Hash)>

Get report definitions Returns the definitions of the reports defined for your tenant.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(PredefinedReportDefsJson, Fixnum, Hash)>) —

    PredefinedReportDefsJson data, response status code and response headers



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/subskribe_sandbox/api/reports_api.rb', line 89

def get_predefined_report_defs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportsApi.get_predefined_report_defs ...'
  end
  # resource path
  local_var_path = '/reports'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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 => 'PredefinedReportDefsJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportsApi#get_predefined_report_defs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_report_output(report_run_id, opts = {}) ⇒ nil

Run a generated report Runs a report generated with /generate. On success a csv of the report is returned.

Parameters:

  • report_run_id —

    id of the report

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

    the optional parameters

Returns:

  • (nil) 


127
128
129
130
 
# File 'lib/subskribe_sandbox/api/reports_api.rb', line 127

def get_report_output(report_run_id, opts = {})
  get_report_output_with_http_info(report_run_id, opts)
  nil
end

#get_report_output_with_http_info(report_run_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Run a generated report Runs a report generated with /generate. On success a csv of the report is returned.

Parameters:

  • report_run_id —

    id of the report

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/subskribe_sandbox/api/reports_api.rb', line 137

def get_report_output_with_http_info(report_run_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportsApi.get_report_output ...'
  end
  # verify the required parameter 'report_run_id' is set
  if @api_client.config.client_side_validation && report_run_id.nil?
    fail ArgumentError, "Missing the required parameter 'report_run_id' when calling ReportsApi.get_report_output"
  end
  # resource path
  local_var_path = '/reports/{reportRunId}/result'.sub('{' + 'reportRunId' + '}', report_run_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream', 'application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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
    @api_client.config.logger.debug "API called: ReportsApi#get_report_output\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#run(body, opts = {}) ⇒ nil

Run a report Runs the specified report and returns the result as a csv.

Parameters:

  • body —

    definition of the report in json

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

    the optional parameters

Returns:

  • (nil) 


178
179
180
181
 
# File 'lib/subskribe_sandbox/api/reports_api.rb', line 178

def run(body, opts = {})
  run_with_http_info(body, opts)
  nil
end

#run_with_http_info(body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Run a report Runs the specified report and returns the result as a csv.

Parameters:

  • body —

    definition of the report in json

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/subskribe_sandbox/api/reports_api.rb', line 188

def run_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportsApi.run ...'
  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 ReportsApi.run"
  end
  # resource path
  local_var_path = '/reports/run'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream', 'application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:POST, 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
    @api_client.config.logger.debug "API called: ReportsApi#run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end