Class: TagApi::TagsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pnap_tag_api/api/tags_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TagsApi

Returns a new instance of TagsApi.



19
20
21
 
# File 'lib/pnap_tag_api/api/tags_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/pnap_tag_api/api/tags_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#tags_get(opts = {}) ⇒ Array<Tag>

List tags. Retrieve all tags belonging to the BMC Account.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Query a tag by its name.

Returns:



27
28
29
30
 
# File 'lib/pnap_tag_api/api/tags_api.rb', line 27

def tags_get(opts = {})
  data, _status_code, _headers = tags_get_with_http_info(opts)
  data
end

#tags_get_with_http_info(opts = {}) ⇒ Array<(Array<Tag>, Integer, Hash)>

List tags. Retrieve all tags belonging to the BMC Account.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Query a tag by its name.

Returns:

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

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



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
75
76
77
78
79
80
 
# File 'lib/pnap_tag_api/api/tags_api.rb', line 37

def tags_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.tags_get ...'
  end
  # resource path
  local_var_path = '/tags'

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

  # 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[:debug_body]

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

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

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

#tags_post(tag_create, opts = {}) ⇒ Tag

Create a Tag. Create a tag with the provided information.

Parameters:

  • tag_create (TagCreate) —

    The body containing the tag details.

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

    the optional parameters

Returns:



87
88
89
90
 
# File 'lib/pnap_tag_api/api/tags_api.rb', line 87

def tags_post(tag_create, opts = {})
  data, _status_code, _headers = tags_post_with_http_info(tag_create, opts)
  data
end

#tags_post_with_http_info(tag_create, opts = {}) ⇒ Array<(Tag, Integer, Hash)>

Create a Tag. Create a tag with the provided information.

Parameters:

  • tag_create (TagCreate) —

    The body containing the tag details.

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

    the optional parameters

Returns:

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

    Tag data, response status code and response headers



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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/pnap_tag_api/api/tags_api.rb', line 97

def tags_post_with_http_info(tag_create, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.tags_post ...'
  end
  # verify the required parameter 'tag_create' is set
  if @api_client.config.client_side_validation && tag_create.nil?
    fail ArgumentError, "Missing the required parameter 'tag_create' when calling TagsApi.tags_post"
  end
  # resource path
  local_var_path = '/tags'

  # 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'
  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(tag_create)

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

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

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

#tags_tag_id_delete(tag_id, opts = {}) ⇒ DeleteResult

Delete a Tag. Delete the tag with the given ID.

Parameters:

  • tag_id (String) —

    The tag&#39;s ID.

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

    the optional parameters

Returns:



155
156
157
158
 
# File 'lib/pnap_tag_api/api/tags_api.rb', line 155

def tags_tag_id_delete(tag_id, opts = {})
  data, _status_code, _headers = tags_tag_id_delete_with_http_info(tag_id, opts)
  data
end

#tags_tag_id_delete_with_http_info(tag_id, opts = {}) ⇒ Array<(DeleteResult, Integer, Hash)>

Delete a Tag. Delete the tag with the given ID.

Parameters:

  • tag_id (String) —

    The tag&#39;s ID.

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

    the optional parameters

Returns:

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

    DeleteResult data, response status code and response headers



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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/pnap_tag_api/api/tags_api.rb', line 165

def tags_tag_id_delete_with_http_info(tag_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.tags_tag_id_delete ...'
  end
  # verify the required parameter 'tag_id' is set
  if @api_client.config.client_side_validation && tag_id.nil?
    fail ArgumentError, "Missing the required parameter 'tag_id' when calling TagsApi.tags_tag_id_delete"
  end
  # resource path
  local_var_path = '/tags/{tagId}'.sub('{' + 'tagId' + '}', CGI.escape(tag_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'])

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

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

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

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

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

#tags_tag_id_get(tag_id, opts = {}) ⇒ Tag

Get a Tag. Retrieve the tag with the given ID

Parameters:

  • tag_id (String) —

    The tag&#39;s ID.

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

    the optional parameters

Returns:



218
219
220
221
 
# File 'lib/pnap_tag_api/api/tags_api.rb', line 218

def tags_tag_id_get(tag_id, opts = {})
  data, _status_code, _headers = tags_tag_id_get_with_http_info(tag_id, opts)
  data
end

#tags_tag_id_get_with_http_info(tag_id, opts = {}) ⇒ Array<(Tag, Integer, Hash)>

Get a Tag. Retrieve the tag with the given ID

Parameters:

  • tag_id (String) —

    The tag&#39;s ID.

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

    the optional parameters

Returns:

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

    Tag data, response status code and response headers



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/pnap_tag_api/api/tags_api.rb', line 228

def tags_tag_id_get_with_http_info(tag_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.tags_tag_id_get ...'
  end
  # verify the required parameter 'tag_id' is set
  if @api_client.config.client_side_validation && tag_id.nil?
    fail ArgumentError, "Missing the required parameter 'tag_id' when calling TagsApi.tags_tag_id_get"
  end
  # resource path
  local_var_path = '/tags/{tagId}'.sub('{' + 'tagId' + '}', CGI.escape(tag_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'])

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

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

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

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

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

#tags_tag_id_patch(tag_id, tag_update, opts = {}) ⇒ Tag

Modify a Tag. Updates the tag with the given ID.

Parameters:

  • tag_id (String) —

    The tag&#39;s ID.

  • tag_update (TagUpdate) —

    The body containing the tag changes.

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

    the optional parameters

Returns:



282
283
284
285
 
# File 'lib/pnap_tag_api/api/tags_api.rb', line 282

def tags_tag_id_patch(tag_id, tag_update, opts = {})
  data, _status_code, _headers = tags_tag_id_patch_with_http_info(tag_id, tag_update, opts)
  data
end

#tags_tag_id_patch_with_http_info(tag_id, tag_update, opts = {}) ⇒ Array<(Tag, Integer, Hash)>

Modify a Tag. Updates the tag with the given ID.

Parameters:

  • tag_id (String) —

    The tag&#39;s ID.

  • tag_update (TagUpdate) —

    The body containing the tag changes.

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

    the optional parameters

Returns:

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

    Tag data, response status code and response headers



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/pnap_tag_api/api/tags_api.rb', line 293

def tags_tag_id_patch_with_http_info(tag_id, tag_update, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.tags_tag_id_patch ...'
  end
  # verify the required parameter 'tag_id' is set
  if @api_client.config.client_side_validation && tag_id.nil?
    fail ArgumentError, "Missing the required parameter 'tag_id' when calling TagsApi.tags_tag_id_patch"
  end
  # verify the required parameter 'tag_update' is set
  if @api_client.config.client_side_validation && tag_update.nil?
    fail ArgumentError, "Missing the required parameter 'tag_update' when calling TagsApi.tags_tag_id_patch"
  end
  # resource path
  local_var_path = '/tags/{tagId}'.sub('{' + 'tagId' + '}', CGI.escape(tag_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'])
  # 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(tag_update)

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

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

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