Class: DependencyTracker::ConfigPropertyApi

Inherits:
Object
  • Object
show all
Defined in:
lib/dependency-tracker-client/api/config_property_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConfigPropertyApi

Returns a new instance of ConfigPropertyApi.



19
20
21
 
# File 'lib/dependency-tracker-client/api/config_property_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/dependency-tracker-client/api/config_property_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_config_properties(opts = {}) ⇒ Array<ConfigProperty>

Returns a list of all ConfigProperties for the specified groupName

Parameters:

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

    the optional parameters

Returns:



25
26
27
28
 
# File 'lib/dependency-tracker-client/api/config_property_api.rb', line 25

def get_config_properties(opts = {})
  data, _status_code, _headers = get_config_properties_with_http_info(opts)
  data
end

#get_config_properties_with_http_info(opts = {}) ⇒ Array<(Array<ConfigProperty>, Integer, Hash)>

Returns a list of all ConfigProperties for the specified groupName

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<ConfigProperty>, Integer, Hash)>) —

    Array<ConfigProperty> 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
70
71
72
73
74
 
# File 'lib/dependency-tracker-client/api/config_property_api.rb', line 33

def get_config_properties_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigPropertyApi.get_config_properties ...'
  end
  # resource path
  local_var_path = '/v1/configProperty'

  # 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/json'])

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

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

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

  # auth_names
  auth_names = opts[:auth_names] || ['X-Api-Key']

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

#update_config_property(opts = {}) ⇒ ConfigProperty

Updates a config property

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



80
81
82
83
 
# File 'lib/dependency-tracker-client/api/config_property_api.rb', line 80

def update_config_property(opts = {})
  data, _status_code, _headers = update_config_property_with_http_info(opts)
  data
end

#update_config_property1(opts = {}) ⇒ Array<ConfigProperty>

Updates an array of config properties

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



138
139
140
141
 
# File 'lib/dependency-tracker-client/api/config_property_api.rb', line 138

def update_config_property1(opts = {})
  data, _status_code, _headers = update_config_property1_with_http_info(opts)
  data
end

#update_config_property1_with_http_info(opts = {}) ⇒ Array<(Array<ConfigProperty>, Integer, Hash)>

Updates an array of config properties

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Array<ConfigProperty>, Integer, Hash)>) —

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



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
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/dependency-tracker-client/api/config_property_api.rb', line 147

def update_config_property1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigPropertyApi.update_config_property1 ...'
  end
  # resource path
  local_var_path = '/v1/configProperty/aggregate'

  # 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/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  # auth_names
  auth_names = opts[:auth_names] || ['X-Api-Key']

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

#update_config_property_with_http_info(opts = {}) ⇒ Array<(ConfigProperty, Integer, Hash)>

Updates a config property

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(ConfigProperty, Integer, Hash)>) —

    ConfigProperty 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
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/dependency-tracker-client/api/config_property_api.rb', line 89

def update_config_property_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigPropertyApi.update_config_property ...'
  end
  # resource path
  local_var_path = '/v1/configProperty'

  # 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/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'ConfigProperty' 

  # auth_names
  auth_names = opts[:auth_names] || ['X-Api-Key']

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