Class: Harbor1Client::RobotAccountApi

Inherits:
Object
  • Object
show all
Defined in:
lib/harbor1_client/api/robot_account_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RobotAccountApi

Returns a new instance of RobotAccountApi.



19
20
21
 
# File 'lib/harbor1_client/api/robot_account_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/harbor1_client/api/robot_account_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#projects_project_id_robots_get(project_id, opts = {}) ⇒ Array<RobotAccount>

Get all robot accounts of specified project Get all robot accounts of specified project

Parameters:

  • project_id —

    Relevant project ID.

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/harbor1_client/api/robot_account_api.rb', line 27

def projects_project_id_robots_get(project_id, opts = {})
  data, _status_code, _headers = projects_project_id_robots_get_with_http_info(project_id, opts)
  data
end

#projects_project_id_robots_get_with_http_info(project_id, opts = {}) ⇒ Array<(Array<RobotAccount>, Fixnum, Hash)>

Get all robot accounts of specified project Get all robot accounts of specified project

Parameters:

  • project_id —

    Relevant project ID.

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

    the optional parameters

Returns:

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

    Array<RobotAccount> 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
 
# File 'lib/harbor1_client/api/robot_account_api.rb', line 37

def projects_project_id_robots_get_with_http_info(project_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RobotAccountApi.projects_project_id_robots_get ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling RobotAccountApi.projects_project_id_robots_get"
  end
  # resource path
  local_var_path = '/projects/{project_id}/robots'.sub('{' + 'project_id' + '}', project_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', 'text/plain'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['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<RobotAccount>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RobotAccountApi#projects_project_id_robots_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_robots_post(project_id, robot, opts = {}) ⇒ RobotAccountPostRep

Create a robot account for project Create a robot account for project

Parameters:

  • project_id —

    Relevant project ID.

  • robot —

    Request body of creating a robot account.

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

    the optional parameters

Returns:



82
83
84
85
 
# File 'lib/harbor1_client/api/robot_account_api.rb', line 82

def projects_project_id_robots_post(project_id, robot, opts = {})
  data, _status_code, _headers = projects_project_id_robots_post_with_http_info(project_id, robot, opts)
  data
end

#projects_project_id_robots_post_with_http_info(project_id, robot, opts = {}) ⇒ Array<(RobotAccountPostRep, Fixnum, Hash)>

Create a robot account for project Create a robot account for project

Parameters:

  • project_id —

    Relevant project ID.

  • robot —

    Request body of creating a robot account.

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

    the optional parameters

Returns:

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

    RobotAccountPostRep data, response status code and response headers



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
133
134
135
 
# File 'lib/harbor1_client/api/robot_account_api.rb', line 93

def projects_project_id_robots_post_with_http_info(project_id, robot, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RobotAccountApi.projects_project_id_robots_post ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling RobotAccountApi.projects_project_id_robots_post"
  end
  # verify the required parameter 'robot' is set
  if @api_client.config.client_side_validation && robot.nil?
    fail ArgumentError, "Missing the required parameter 'robot' when calling RobotAccountApi.projects_project_id_robots_post"
  end
  # resource path
  local_var_path = '/projects/{project_id}/robots'.sub('{' + 'project_id' + '}', project_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', 'text/plain'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(robot)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RobotAccountPostRep')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RobotAccountApi#projects_project_id_robots_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_robots_robot_id_delete(project_id, robot_id, opts = {}) ⇒ nil

Delete the specified robot account Delete the specified robot account

Parameters:

  • project_id —

    Relevant project ID.

  • robot_id —

    The ID of robot account.

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

    the optional parameters

Returns:

  • (nil) 


142
143
144
145
 
# File 'lib/harbor1_client/api/robot_account_api.rb', line 142

def projects_project_id_robots_robot_id_delete(project_id, robot_id, opts = {})
  projects_project_id_robots_robot_id_delete_with_http_info(project_id, robot_id, opts)
  nil
end

#projects_project_id_robots_robot_id_delete_with_http_info(project_id, robot_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete the specified robot account Delete the specified robot account

Parameters:

  • project_id —

    Relevant project ID.

  • robot_id —

    The ID of robot account.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
191
192
193
194
 
# File 'lib/harbor1_client/api/robot_account_api.rb', line 153

def projects_project_id_robots_robot_id_delete_with_http_info(project_id, robot_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RobotAccountApi.projects_project_id_robots_robot_id_delete ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling RobotAccountApi.projects_project_id_robots_robot_id_delete"
  end
  # verify the required parameter 'robot_id' is set
  if @api_client.config.client_side_validation && robot_id.nil?
    fail ArgumentError, "Missing the required parameter 'robot_id' when calling RobotAccountApi.projects_project_id_robots_robot_id_delete"
  end
  # resource path
  local_var_path = '/projects/{project_id}/robots/{robot_id}'.sub('{' + 'project_id' + '}', project_id.to_s).sub('{' + 'robot_id' + '}', robot_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', 'text/plain'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, 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: RobotAccountApi#projects_project_id_robots_robot_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_robots_robot_id_get(project_id, robot_id, opts = {}) ⇒ RobotAccount

Return the infor of the specified robot account. Return the infor of the specified robot account.

Parameters:

  • project_id —

    Relevant project ID.

  • robot_id —

    The ID of robot account.

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

    the optional parameters

Returns:



201
202
203
204
 
# File 'lib/harbor1_client/api/robot_account_api.rb', line 201

def projects_project_id_robots_robot_id_get(project_id, robot_id, opts = {})
  data, _status_code, _headers = projects_project_id_robots_robot_id_get_with_http_info(project_id, robot_id, opts)
  data
end

#projects_project_id_robots_robot_id_get_with_http_info(project_id, robot_id, opts = {}) ⇒ Array<(RobotAccount, Fixnum, Hash)>

Return the infor of the specified robot account. Return the infor of the specified robot account.

Parameters:

  • project_id —

    Relevant project ID.

  • robot_id —

    The ID of robot account.

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

    the optional parameters

Returns:

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

    RobotAccount data, response status code and response headers



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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/harbor1_client/api/robot_account_api.rb', line 212

def projects_project_id_robots_robot_id_get_with_http_info(project_id, robot_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RobotAccountApi.projects_project_id_robots_robot_id_get ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling RobotAccountApi.projects_project_id_robots_robot_id_get"
  end
  # verify the required parameter 'robot_id' is set
  if @api_client.config.client_side_validation && robot_id.nil?
    fail ArgumentError, "Missing the required parameter 'robot_id' when calling RobotAccountApi.projects_project_id_robots_robot_id_get"
  end
  # resource path
  local_var_path = '/projects/{project_id}/robots/{robot_id}'.sub('{' + 'project_id' + '}', project_id.to_s).sub('{' + 'robot_id' + '}', robot_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', 'text/plain'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['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 => 'RobotAccount')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RobotAccountApi#projects_project_id_robots_robot_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_robots_robot_id_put(project_id, robot_id, robot, opts = {}) ⇒ nil

Update status of robot account. Used to disable/enable a specified robot account.

Parameters:

  • project_id —

    Relevant project ID.

  • robot_id —

    The ID of robot account.

  • robot —

    Request body of enable/disable a robot account.

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

    the optional parameters

Returns:

  • (nil) 


262
263
264
265
 
# File 'lib/harbor1_client/api/robot_account_api.rb', line 262

def projects_project_id_robots_robot_id_put(project_id, robot_id, robot, opts = {})
  projects_project_id_robots_robot_id_put_with_http_info(project_id, robot_id, robot, opts)
  nil
end

#projects_project_id_robots_robot_id_put_with_http_info(project_id, robot_id, robot, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update status of robot account. Used to disable/enable a specified robot account.

Parameters:

  • project_id —

    Relevant project ID.

  • robot_id —

    The ID of robot account.

  • robot —

    Request body of enable/disable a robot account.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
312
313
314
315
316
317
318
319
 
# File 'lib/harbor1_client/api/robot_account_api.rb', line 274

def projects_project_id_robots_robot_id_put_with_http_info(project_id, robot_id, robot, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RobotAccountApi.projects_project_id_robots_robot_id_put ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling RobotAccountApi.projects_project_id_robots_robot_id_put"
  end
  # verify the required parameter 'robot_id' is set
  if @api_client.config.client_side_validation && robot_id.nil?
    fail ArgumentError, "Missing the required parameter 'robot_id' when calling RobotAccountApi.projects_project_id_robots_robot_id_put"
  end
  # verify the required parameter 'robot' is set
  if @api_client.config.client_side_validation && robot.nil?
    fail ArgumentError, "Missing the required parameter 'robot' when calling RobotAccountApi.projects_project_id_robots_robot_id_put"
  end
  # resource path
  local_var_path = '/projects/{project_id}/robots/{robot_id}'.sub('{' + 'project_id' + '}', project_id.to_s).sub('{' + 'robot_id' + '}', robot_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', 'text/plain'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(robot)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, 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: RobotAccountApi#projects_project_id_robots_robot_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end