Class: ConnectWise::ReportsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/connectwise-ruby-sdk/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.



8
9
10
 
# File 'lib/connectwise-ruby-sdk/api/reports_api.rb', line 8

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



6
7
8
 
# File 'lib/connectwise-ruby-sdk/api/reports_api.rb', line 6

def api_client
  @api_client
end

Instance Method Details

#system_reports_get(opts = {}) ⇒ Array<Report>

Get Reports

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :order_by (String)
  • :childconditions (String)
  • :customfieldconditions (String)

Returns:



20
21
22
23
 
# File 'lib/connectwise-ruby-sdk/api/reports_api.rb', line 20

def system_reports_get(opts = {})
  data, _status_code, _headers = system_reports_get_with_http_info(opts)
  return data
end

#system_reports_get_with_http_info(opts = {}) ⇒ Array<(Array<Report>, Fixnum, Hash)>

Get Reports

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :order_by (String)
  • :childconditions (String)
  • :customfieldconditions (String)

Returns:

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

    Array<Report> data, response status code and response headers



33
34
35
36
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
 
# File 'lib/connectwise-ruby-sdk/api/reports_api.rb', line 33

def system_reports_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ReportsApi.system_reports_get ..."
  end
  # resource path
  local_var_path = "/system/reports"

  # query parameters
  query_params = {}
  query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'childconditions'] = opts[:'childconditions'] if !opts[:'childconditions'].nil?
  query_params[:'customfieldconditions'] = opts[:'customfieldconditions'] if !opts[:'customfieldconditions'].nil?

  # 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 = ['BasicAuth']
  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 => 'Array<Report>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportsApi#system_reports_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_reports_report_name_columns_get(report_name, opts = {}) ⇒ Array<JObject>

Get Column Definitions

Parameters:

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

    the optional parameters

Returns:



76
77
78
79
 
# File 'lib/connectwise-ruby-sdk/api/reports_api.rb', line 76

def system_reports_report_name_columns_get(report_name, opts = {})
  data, _status_code, _headers = system_reports_report_name_columns_get_with_http_info(report_name, opts)
  return data
end

#system_reports_report_name_columns_get_with_http_info(report_name, opts = {}) ⇒ Array<(Array<JObject>, Fixnum, Hash)>

Get Column Definitions

Parameters:

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

    the optional parameters

Returns:

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

    Array<JObject> data, response status code and response headers



86
87
88
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
122
 
# File 'lib/connectwise-ruby-sdk/api/reports_api.rb', line 86

def system_reports_report_name_columns_get_with_http_info(report_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ReportsApi.system_reports_report_name_columns_get ..."
  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 ReportsApi.system_reports_report_name_columns_get"
  end
  # resource path
  local_var_path = "/system/reports/{reportName}/columns".sub('{' + 'reportName' + '}', report_name.to_s)

  # 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 = ['BasicAuth']
  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 => 'Array<JObject>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportsApi#system_reports_report_name_columns_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_reports_report_name_count_get(report_name, opts = {}) ⇒ Count

Get Report Results Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:



130
131
132
133
 
# File 'lib/connectwise-ruby-sdk/api/reports_api.rb', line 130

def system_reports_report_name_count_get(report_name, opts = {})
  data, _status_code, _headers = system_reports_report_name_count_get_with_http_info(report_name, opts)
  return data
end

#system_reports_report_name_count_get_with_http_info(report_name, opts = {}) ⇒ Array<(Count, Fixnum, Hash)>

Get Report Results Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:

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

    Count data, response status code and response headers



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
 
# File 'lib/connectwise-ruby-sdk/api/reports_api.rb', line 141

def system_reports_report_name_count_get_with_http_info(report_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ReportsApi.system_reports_report_name_count_get ..."
  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 ReportsApi.system_reports_report_name_count_get"
  end
  # resource path
  local_var_path = "/system/reports/{reportName}/count".sub('{' + 'reportName' + '}', report_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].nil?

  # 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 = ['BasicAuth']
  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 => 'Count')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportsApi#system_reports_report_name_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_reports_report_name_get(report_name, opts = {}) ⇒ ReportDataResponse

Get Report Results

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :order_by (String)
  • :childconditions (String)
  • :customfieldconditions (String)
  • :page (Integer)
  • :page_size (Integer)
  • :columns (String)

Returns:



192
193
194
195
 
# File 'lib/connectwise-ruby-sdk/api/reports_api.rb', line 192

def system_reports_report_name_get(report_name, opts = {})
  data, _status_code, _headers = system_reports_report_name_get_with_http_info(report_name, opts)
  return data
end

#system_reports_report_name_get_with_http_info(report_name, opts = {}) ⇒ Array<(ReportDataResponse, Fixnum, Hash)>

Get Report Results

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :order_by (String)
  • :childconditions (String)
  • :customfieldconditions (String)
  • :page (Integer)
  • :page_size (Integer)
  • :columns (String)

Returns:

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

    ReportDataResponse data, response status code and response headers



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/connectwise-ruby-sdk/api/reports_api.rb', line 209

def system_reports_report_name_get_with_http_info(report_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ReportsApi.system_reports_report_name_get ..."
  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 ReportsApi.system_reports_report_name_get"
  end
  # resource path
  local_var_path = "/system/reports/{reportName}".sub('{' + 'reportName' + '}', report_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'childconditions'] = opts[:'childconditions'] if !opts[:'childconditions'].nil?
  query_params[:'customfieldconditions'] = opts[:'customfieldconditions'] if !opts[:'customfieldconditions'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'columns'] = opts[:'columns'] if !opts[:'columns'].nil?

  # 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 = ['BasicAuth']
  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 => 'ReportDataResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportsApi#system_reports_report_name_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end