Class: EmassClient::SoftwareBaselineApi

Inherits:
Object
  • Object
show all
Defined in:
lib/emass_client/api/software_baseline_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SoftwareBaselineApi

Returns a new instance of SoftwareBaselineApi.



19
20
21
 
# File 'lib/emass_client/api/software_baseline_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/emass_client/api/software_baseline_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_sw_baseline_assets(system_id, sw_baseline_required_fields, opts = {}) ⇒ SwBaselineResponsePostPut

Add one or many software assets in a system Adds assets to the Software Baseline for given systemId **Request Body Required Fields** - softwareVendor - softwareName - version

Parameters:

  • system_id (Integer) —

    **System Id**: The unique system record identifier.

  • sw_baseline_required_fields (Array<SwBaselineRequiredFields>) —

    Example request body for adding software baseline assets to an existing System (systemId)

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/emass_client/api/software_baseline_api.rb', line 28

def add_sw_baseline_assets(system_id, sw_baseline_required_fields, opts = {})
  data, _status_code, _headers = add_sw_baseline_assets_with_http_info(system_id, sw_baseline_required_fields, opts)
  data
end

#add_sw_baseline_assets_with_http_info(system_id, sw_baseline_required_fields, opts = {}) ⇒ Array<(SwBaselineResponsePostPut, Integer, Hash)>

Add one or many software assets in a system Adds assets to the Software Baseline for given &#x60;systemId&#x60; **Request Body Required Fields** - &#x60;softwareVendor&#x60; - &#x60;softwareName&#x60; - &#x60;version&#x60;

Parameters:

  • system_id (Integer) —

    **System Id**: The unique system record identifier.

  • sw_baseline_required_fields (Array<SwBaselineRequiredFields>) —

    Example request body for adding software baseline assets to an existing System (systemId)

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

    the optional parameters

Returns:

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

    SwBaselineResponsePostPut data, response status code and response headers



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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/emass_client/api/software_baseline_api.rb', line 39

def add_sw_baseline_assets_with_http_info(system_id, sw_baseline_required_fields, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SoftwareBaselineApi.add_sw_baseline_assets ...'
  end
  # verify the required parameter 'system_id' is set
  if @api_client.config.client_side_validation && system_id.nil?
    fail ArgumentError, "Missing the required parameter 'system_id' when calling SoftwareBaselineApi.add_sw_baseline_assets"
  end
  # verify the required parameter 'sw_baseline_required_fields' is set
  if @api_client.config.client_side_validation && sw_baseline_required_fields.nil?
    fail ArgumentError, "Missing the required parameter 'sw_baseline_required_fields' when calling SoftwareBaselineApi.add_sw_baseline_assets"
  end
  # resource path
  local_var_path = '/api/systems/{systemId}/sw-baseline'.sub('{' + 'systemId' + '}', CGI.escape(system_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/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']

  new_options = opts.merge(
    :operation => :"SoftwareBaselineApi.add_sw_baseline_assets",
    :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: SoftwareBaselineApi#add_sw_baseline_assets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_sw_baseline_assets(system_id, sw_baseline_request_delete_body_inner, opts = {}) ⇒ SwBaselineResponseDelete

Delete one or many software assets in a system Remove (delete) one or multiple assets from a system Software Baseline

Parameters:

  • system_id (Integer) —

    **System Id**: The unique system record identifier.

  • sw_baseline_request_delete_body_inner (Array<SwBaselineRequestDeleteBodyInner>) —

    Example request body for deleting one or many Software Baseline assets

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

    the optional parameters

Returns:



102
103
104
105
 
# File 'lib/emass_client/api/software_baseline_api.rb', line 102

def delete_sw_baseline_assets(system_id, sw_baseline_request_delete_body_inner, opts = {})
  data, _status_code, _headers = delete_sw_baseline_assets_with_http_info(system_id, sw_baseline_request_delete_body_inner, opts)
  data
end

#delete_sw_baseline_assets_with_http_info(system_id, sw_baseline_request_delete_body_inner, opts = {}) ⇒ Array<(SwBaselineResponseDelete, Integer, Hash)>

Delete one or many software assets in a system Remove (delete) one or multiple assets from a system Software Baseline

Parameters:

  • system_id (Integer) —

    **System Id**: The unique system record identifier.

  • sw_baseline_request_delete_body_inner (Array<SwBaselineRequestDeleteBodyInner>) —

    Example request body for deleting one or many Software Baseline assets

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

    the optional parameters

Returns:

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

    SwBaselineResponseDelete data, response status code and response headers



113
114
115
116
117
118
119
120
121
122
123
124
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
 
# File 'lib/emass_client/api/software_baseline_api.rb', line 113

def delete_sw_baseline_assets_with_http_info(system_id, sw_baseline_request_delete_body_inner, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SoftwareBaselineApi.delete_sw_baseline_assets ...'
  end
  # verify the required parameter 'system_id' is set
  if @api_client.config.client_side_validation && system_id.nil?
    fail ArgumentError, "Missing the required parameter 'system_id' when calling SoftwareBaselineApi.delete_sw_baseline_assets"
  end
  # verify the required parameter 'sw_baseline_request_delete_body_inner' is set
  if @api_client.config.client_side_validation && sw_baseline_request_delete_body_inner.nil?
    fail ArgumentError, "Missing the required parameter 'sw_baseline_request_delete_body_inner' when calling SoftwareBaselineApi.delete_sw_baseline_assets"
  end
  # resource path
  local_var_path = '/api/systems/{systemId}/sw-baseline'.sub('{' + 'systemId' + '}', CGI.escape(system_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/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']

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

#get_system_sw_baseline(system_id, opts = {}) ⇒ SwBaselineResponseGet

Get software baseline for a system Returns the software baseline for a system matching the systemId path parameter

Parameters:

  • system_id (Integer) —

    **System Id**: The unique system record identifier.

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

    the optional parameters

Options Hash (opts):

  • :page_index (Integer) —

    **Page Index**: If no value is specified, the default returns results from the first page with an index of 0. (default to 0)

  • :page_size (Integer) —

    **Page Size**: If no value is specified, the default returns 20000 per page. (default to 20000)

Returns:



177
178
179
180
 
# File 'lib/emass_client/api/software_baseline_api.rb', line 177

def get_system_sw_baseline(system_id, opts = {})
  data, _status_code, _headers = get_system_sw_baseline_with_http_info(system_id, opts)
  data
end

#get_system_sw_baseline_with_http_info(system_id, opts = {}) ⇒ Array<(SwBaselineResponseGet, Integer, Hash)>

Get software baseline for a system Returns the software baseline for a system matching the &#x60;systemId&#x60; path parameter

Parameters:

  • system_id (Integer) —

    **System Id**: The unique system record identifier.

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

    the optional parameters

Options Hash (opts):

  • :page_index (Integer) —

    **Page Index**: If no value is specified, the default returns results from the first page with an index of 0. (default to 0)

  • :page_size (Integer) —

    **Page Size**: If no value is specified, the default returns 20000 per page. (default to 20000)

Returns:

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

    SwBaselineResponseGet data, response status code and response headers



189
190
191
192
193
194
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
 
# File 'lib/emass_client/api/software_baseline_api.rb', line 189

def get_system_sw_baseline_with_http_info(system_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SoftwareBaselineApi.get_system_sw_baseline ...'
  end
  # verify the required parameter 'system_id' is set
  if @api_client.config.client_side_validation && system_id.nil?
    fail ArgumentError, "Missing the required parameter 'system_id' when calling SoftwareBaselineApi.get_system_sw_baseline"
  end
  # resource path
  local_var_path = '/api/systems/{systemId}/sw-baseline'.sub('{' + 'systemId' + '}', CGI.escape(system_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageIndex'] = opts[:'page_index'] if !opts[:'page_index'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']

  new_options = opts.merge(
    :operation => :"SoftwareBaselineApi.get_system_sw_baseline",
    :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: SoftwareBaselineApi#get_system_sw_baseline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_sw_baseline_assets(system_id, sw_baseline_read_only_fields, opts = {}) ⇒ SwBaselineResponsePostPut

Update one or many software assets in a system Updates assets in the Software Baseline for given systemId **Request Body Required Fields** - softwareId - softwareVendor - softwareName - version

Parameters:

  • system_id (Integer) —

    **System Id**: The unique system record identifier.

  • sw_baseline_read_only_fields (Array<SwBaselineReadOnlyFields>) —

    Example request body for updating software baseline assets to an existing System (systemId)

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

    the optional parameters

Returns:



245
246
247
248
 
# File 'lib/emass_client/api/software_baseline_api.rb', line 245

def update_sw_baseline_assets(system_id, sw_baseline_read_only_fields, opts = {})
  data, _status_code, _headers = update_sw_baseline_assets_with_http_info(system_id, sw_baseline_read_only_fields, opts)
  data
end

#update_sw_baseline_assets_with_http_info(system_id, sw_baseline_read_only_fields, opts = {}) ⇒ Array<(SwBaselineResponsePostPut, Integer, Hash)>

Update one or many software assets in a system Updates assets in the Software Baseline for given &#x60;systemId&#x60; **Request Body Required Fields** - &#x60;softwareId&#x60; - &#x60;softwareVendor&#x60; - &#x60;softwareName&#x60; - &#x60;version&#x60;

Parameters:

  • system_id (Integer) —

    **System Id**: The unique system record identifier.

  • sw_baseline_read_only_fields (Array<SwBaselineReadOnlyFields>) —

    Example request body for updating software baseline assets to an existing System (systemId)

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

    the optional parameters

Returns:

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

    SwBaselineResponsePostPut data, response status code and response headers



256
257
258
259
260
261
262
263
264
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
 
# File 'lib/emass_client/api/software_baseline_api.rb', line 256

def update_sw_baseline_assets_with_http_info(system_id, sw_baseline_read_only_fields, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SoftwareBaselineApi.update_sw_baseline_assets ...'
  end
  # verify the required parameter 'system_id' is set
  if @api_client.config.client_side_validation && system_id.nil?
    fail ArgumentError, "Missing the required parameter 'system_id' when calling SoftwareBaselineApi.update_sw_baseline_assets"
  end
  # verify the required parameter 'sw_baseline_read_only_fields' is set
  if @api_client.config.client_side_validation && sw_baseline_read_only_fields.nil?
    fail ArgumentError, "Missing the required parameter 'sw_baseline_read_only_fields' when calling SoftwareBaselineApi.update_sw_baseline_assets"
  end
  # resource path
  local_var_path = '/api/systems/{systemId}/sw-baseline'.sub('{' + 'systemId' + '}', CGI.escape(system_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/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']

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