Class: ConnectWise::ManagementLogsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/connectwise-ruby-sdk/api/management_logs_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ManagementLogsApi

Returns a new instance of ManagementLogsApi.



8
9
10
 
# File 'lib/connectwise-ruby-sdk/api/management_logs_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/management_logs_api.rb', line 6

def api_client
  @api_client
end

Instance Method Details

#company_management_id_log_download_get(opts = {}) ⇒ nil

Download Document

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :file_path (String)

Returns:

  • (nil) 


17
18
19
20
 
# File 'lib/connectwise-ruby-sdk/api/management_logs_api.rb', line 17

def company_management_id_log_download_get(opts = {})
  company_management_id_log_download_get_with_http_info(opts)
  return nil
end

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

Download Document

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :file_path (String)

Returns:

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

    nil, response status code and response headers



27
28
29
30
31
32
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
 
# File 'lib/connectwise-ruby-sdk/api/management_logs_api.rb', line 27

def company_management_id_log_download_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ManagementLogsApi.company_management_id_log_download_get ..."
  end
  # resource path
  local_var_path = "/company/management/{id}/log/download"

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

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

  # 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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementLogsApi#company_management_id_log_download_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#company_management_id_logs_get(opts = {}) ⇒ Array<ManagementLogDocumentInfo>

Get Management Execute Managed It Syncs

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



71
72
73
74
 
# File 'lib/connectwise-ruby-sdk/api/management_logs_api.rb', line 71

def company_management_id_logs_get(opts = {})
  data, _status_code, _headers = company_management_id_logs_get_with_http_info(opts)
  return data
end

#company_management_id_logs_get_with_http_info(opts = {}) ⇒ Array<(Array<ManagementLogDocumentInfo>, Fixnum, Hash)>

Get Management Execute Managed It Syncs

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    Array<ManagementLogDocumentInfo> 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
123
124
 
# File 'lib/connectwise-ruby-sdk/api/management_logs_api.rb', line 86

def company_management_id_logs_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ManagementLogsApi.company_management_id_logs_get ..."
  end
  # resource path
  local_var_path = "/company/management/{id}/logs"

  # 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?

  # 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<ManagementLogDocumentInfo>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementLogsApi#company_management_id_logs_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end