Class: ConnectWise::ManagementReportSetupsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/connect_wise/api/management_report_setups_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ManagementReportSetupsApi 



17
18
19
 
# File 'lib/connect_wise/api/management_report_setups_api.rb', line 17

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/connect_wise/api/management_report_setups_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#get_company_companies_by_parent_id_management_report_setup(parent_id, client_id, opts = {}) ⇒ Array<ManagementReportSetup>

Get List of ManagementReportSetup

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer) 


34
35
36
37
 
# File 'lib/connect_wise/api/management_report_setups_api.rb', line 34

def get_company_companies_by_parent_id_management_report_setup(parent_id, client_id, opts = {})
  data, _status_code, _headers = get_company_companies_by_parent_id_management_report_setup_with_http_info(parent_id, client_id, opts)
  data
end

#get_company_companies_by_parent_id_management_report_setup_with_http_info(parent_id, client_id, opts = {}) ⇒ Array<(Array<ManagementReportSetup>, Integer, Hash)>

Get List of ManagementReportSetup

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Raises:

  • (ArgumentError) 


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
 
# File 'lib/connect_wise/api/management_report_setups_api.rb', line 52

def get_company_companies_by_parent_id_management_report_setup_with_http_info(parent_id, client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: ManagementReportSetupsApi.get_company_companies_by_parent_id_management_report_setup ...' if @api_client.config.debugging
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling ManagementReportSetupsApi.get_company_companies_by_parent_id_management_report_setup" if @api_client.config.client_side_validation && parent_id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling ManagementReportSetupsApi.get_company_companies_by_parent_id_management_report_setup" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/company/companies/{parentId}/managementReportSetup'.sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:conditions] = opts[:conditions] unless opts[:conditions].nil?
  query_params[:childConditions] = opts[:child_conditions] unless opts[:child_conditions].nil?
  query_params[:customFieldConditions] = opts[:custom_field_conditions] unless opts[:custom_field_conditions].nil?
  query_params[:orderBy] = opts[:order_by] unless opts[:order_by].nil?
  query_params[:fields] = opts[:fields] unless opts[:fields].nil?
  query_params[:page] = opts[:page] unless opts[:page].nil?
  query_params[:pageSize] = opts[:page_size] unless opts[:page_size].nil?
  query_params[:pageId] = opts[:page_id] unless opts[:page_id].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<ManagementReportSetup>'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'ManagementReportSetupsApi.get_company_companies_by_parent_id_management_report_setup',
    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, new_options)
  @api_client.config.logger.debug "API called: ManagementReportSetupsApi#get_company_companies_by_parent_id_management_report_setup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#patch_company_companies_by_parent_id_management_report_setup_by_id(id, parent_id, client_id, patch_operation, opts = {}) ⇒ ManagementReportSetup

Patch ManagementReportSetup



113
114
115
116
 
# File 'lib/connect_wise/api/management_report_setups_api.rb', line 113

def patch_company_companies_by_parent_id_management_report_setup_by_id(id, parent_id, client_id, patch_operation, opts = {})
  data, _status_code, _headers = patch_company_companies_by_parent_id_management_report_setup_by_id_with_http_info(id, parent_id, client_id, patch_operation, opts)
  data
end

#patch_company_companies_by_parent_id_management_report_setup_by_id_with_http_info(id, parent_id, client_id, patch_operation, opts = {}) ⇒ Array<(ManagementReportSetup, Integer, Hash)>

Patch ManagementReportSetup

Raises:

  • (ArgumentError) 


125
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
 
# File 'lib/connect_wise/api/management_report_setups_api.rb', line 125

def patch_company_companies_by_parent_id_management_report_setup_by_id_with_http_info(id, parent_id, client_id, patch_operation, opts = {})
  @api_client.config.logger.debug 'Calling API: ManagementReportSetupsApi.patch_company_companies_by_parent_id_management_report_setup_by_id ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  raise ArgumentError, "Missing the required parameter 'id' when calling ManagementReportSetupsApi.patch_company_companies_by_parent_id_management_report_setup_by_id" if @api_client.config.client_side_validation && id.nil?
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling ManagementReportSetupsApi.patch_company_companies_by_parent_id_management_report_setup_by_id" if @api_client.config.client_side_validation && parent_id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling ManagementReportSetupsApi.patch_company_companies_by_parent_id_management_report_setup_by_id" if @api_client.config.client_side_validation && client_id.nil?
  # verify the required parameter 'patch_operation' is set
  raise ArgumentError, "Missing the required parameter 'patch_operation' when calling ManagementReportSetupsApi.patch_company_companies_by_parent_id_management_report_setup_by_id" if @api_client.config.client_side_validation && patch_operation.nil?

  # resource path
  local_var_path = '/company/companies/{parentId}/managementReportSetup/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  header_params['Content-Type'] = content_type unless content_type.nil?
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_operation)

  # return_type
  return_type = opts[:debug_return_type] || 'ManagementReportSetup'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'ManagementReportSetupsApi.patch_company_companies_by_parent_id_management_report_setup_by_id',
    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(:PATCH, local_var_path, new_options)
  @api_client.config.logger.debug "API called: ManagementReportSetupsApi#patch_company_companies_by_parent_id_management_report_setup_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#post_company_companies_by_parent_id_management_report_setup(parent_id, client_id, management_report_setup, opts = {}) ⇒ ManagementReportSetup

Post ManagementReportSetup



184
185
186
187
 
# File 'lib/connect_wise/api/management_report_setups_api.rb', line 184

def post_company_companies_by_parent_id_management_report_setup(parent_id, client_id, management_report_setup, opts = {})
  data, _status_code, _headers = post_company_companies_by_parent_id_management_report_setup_with_http_info(parent_id, client_id, management_report_setup, opts)
  data
end

#post_company_companies_by_parent_id_management_report_setup_with_http_info(parent_id, client_id, management_report_setup, opts = {}) ⇒ Array<(ManagementReportSetup, Integer, Hash)>

Post ManagementReportSetup

Raises:

  • (ArgumentError) 


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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/connect_wise/api/management_report_setups_api.rb', line 195

def post_company_companies_by_parent_id_management_report_setup_with_http_info(parent_id, client_id, management_report_setup, opts = {})
  @api_client.config.logger.debug 'Calling API: ManagementReportSetupsApi.post_company_companies_by_parent_id_management_report_setup ...' if @api_client.config.debugging
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling ManagementReportSetupsApi.post_company_companies_by_parent_id_management_report_setup" if @api_client.config.client_side_validation && parent_id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling ManagementReportSetupsApi.post_company_companies_by_parent_id_management_report_setup" if @api_client.config.client_side_validation && client_id.nil?
  # verify the required parameter 'management_report_setup' is set
  raise ArgumentError, "Missing the required parameter 'management_report_setup' when calling ManagementReportSetupsApi.post_company_companies_by_parent_id_management_report_setup" if @api_client.config.client_side_validation && management_report_setup.nil?

  # resource path
  local_var_path = '/company/companies/{parentId}/managementReportSetup'.sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  header_params['Content-Type'] = content_type unless content_type.nil?
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(management_report_setup)

  # return_type
  return_type = opts[:debug_return_type] || 'ManagementReportSetup'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'ManagementReportSetupsApi.post_company_companies_by_parent_id_management_report_setup',
    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(:POST, local_var_path, new_options)
  @api_client.config.logger.debug "API called: ManagementReportSetupsApi#post_company_companies_by_parent_id_management_report_setup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#put_company_companies_by_parent_id_management_report_setup_by_id(id, parent_id, client_id, management_report_setup, opts = {}) ⇒ ManagementReportSetup

Put ManagementReportSetup



253
254
255
256
 
# File 'lib/connect_wise/api/management_report_setups_api.rb', line 253

def put_company_companies_by_parent_id_management_report_setup_by_id(id, parent_id, client_id, management_report_setup, opts = {})
  data, _status_code, _headers = put_company_companies_by_parent_id_management_report_setup_by_id_with_http_info(id, parent_id, client_id, management_report_setup, opts)
  data
end

#put_company_companies_by_parent_id_management_report_setup_by_id_with_http_info(id, parent_id, client_id, management_report_setup, opts = {}) ⇒ Array<(ManagementReportSetup, Integer, Hash)>

Put ManagementReportSetup

Raises:

  • (ArgumentError) 


265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/connect_wise/api/management_report_setups_api.rb', line 265

def put_company_companies_by_parent_id_management_report_setup_by_id_with_http_info(id, parent_id, client_id, management_report_setup, opts = {})
  @api_client.config.logger.debug 'Calling API: ManagementReportSetupsApi.put_company_companies_by_parent_id_management_report_setup_by_id ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  raise ArgumentError, "Missing the required parameter 'id' when calling ManagementReportSetupsApi.put_company_companies_by_parent_id_management_report_setup_by_id" if @api_client.config.client_side_validation && id.nil?
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling ManagementReportSetupsApi.put_company_companies_by_parent_id_management_report_setup_by_id" if @api_client.config.client_side_validation && parent_id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling ManagementReportSetupsApi.put_company_companies_by_parent_id_management_report_setup_by_id" if @api_client.config.client_side_validation && client_id.nil?
  # verify the required parameter 'management_report_setup' is set
  raise ArgumentError, "Missing the required parameter 'management_report_setup' when calling ManagementReportSetupsApi.put_company_companies_by_parent_id_management_report_setup_by_id" if @api_client.config.client_side_validation && management_report_setup.nil?

  # resource path
  local_var_path = '/company/companies/{parentId}/managementReportSetup/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  header_params['Content-Type'] = content_type unless content_type.nil?
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(management_report_setup)

  # return_type
  return_type = opts[:debug_return_type] || 'ManagementReportSetup'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'ManagementReportSetupsApi.put_company_companies_by_parent_id_management_report_setup_by_id',
    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(:PUT, local_var_path, new_options)
  @api_client.config.logger.debug "API called: ManagementReportSetupsApi#put_company_companies_by_parent_id_management_report_setup_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end