Class: ConnectWise::KPICategoriesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ KPICategoriesApi

Returns a new instance of KPICategoriesApi.

[View source]

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

def api_client
  @api_client
end

Instance Method Details

#system_kpi_categories_count_get(opts = {}) ⇒ Count

Get K P I Categories Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:

[View source]

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

def system_kpi_categories_count_get(opts = {})
  data, _status_code, _headers = system_kpi_categories_count_get_with_http_info(opts)
  return data
end

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

Get K P I Categories Count

Parameters:

  • 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

[View source]

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

def system_kpi_categories_count_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: KPICategoriesApi.system_kpi_categories_count_get ..."
  end
  # resource path
  local_var_path = "/system/kpiCategories/count"

  # 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: KPICategoriesApi#system_kpi_categories_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_kpi_categories_get(opts = {}) ⇒ Array<KPICategory>

Get K P I Categories

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:

[View source]

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

def system_kpi_categories_get(opts = {})
  data, _status_code, _headers = system_kpi_categories_get_with_http_info(opts)
  return data
end

#system_kpi_categories_get_with_http_info(opts = {}) ⇒ Array<(Array<KPICategory>, Fixnum, Hash)>

Get K P I Categories

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<KPICategory>, Fixnum, Hash)>) —

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

[View source]

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

def system_kpi_categories_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: KPICategoriesApi.system_kpi_categories_get ..."
  end
  # resource path
  local_var_path = "/system/kpiCategories"

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

#system_kpi_categories_id_get(id, opts = {}) ⇒ KPICategory

Get K P I Category By Id

Parameters:

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

    the optional parameters

Returns:

[View source]

132
133
134
135
 
# File 'lib/connectwise-ruby-sdk/api/kpi_categories_api.rb', line 132

def system_kpi_categories_id_get(id, opts = {})
  data, _status_code, _headers = system_kpi_categories_id_get_with_http_info(id, opts)
  return data
end

#system_kpi_categories_id_get_with_http_info(id, opts = {}) ⇒ Array<(KPICategory, Fixnum, Hash)>

Get K P I Category By Id

Parameters:

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

    the optional parameters

Returns:

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

    KPICategory data, response status code and response headers

[View source]

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/kpi_categories_api.rb', line 142

def system_kpi_categories_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: KPICategoriesApi.system_kpi_categories_id_get ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling KPICategoriesApi.system_kpi_categories_id_get"
  end
  # resource path
  local_var_path = "/system/kpiCategories/{id}".sub('{' + 'id' + '}', 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/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 => 'KPICategory')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: KPICategoriesApi#system_kpi_categories_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end