Class: ApprovalApiClient::ActionApi

Inherits:
Object
  • Object
show all
Defined in:
lib/insights-approval-api-client/api/action_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ActionApi

Returns a new instance of ActionApi.



19
20
21
 
# File 'lib/insights-approval-api-client/api/action_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/insights-approval-api-client/api/action_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_action(request_id, action, opts = {}) ⇒ Action

Add an action to a given request Add an action to a given request. Admin can do approve, deny, memo, and cancel operations; approver can do approve, deny and memo operations; while requester can do only cancel operation.

Parameters:

  • request_id (String) —

    Id of request

  • action (Action) —

    Action object that will be added

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/insights-approval-api-client/api/action_api.rb', line 28

def create_action(request_id, action, opts = {})
  data, _status_code, _headers = create_action_with_http_info(request_id, action, opts)
  data
end

#create_action_with_http_info(request_id, action, opts = {}) ⇒ Array<(Action, Integer, Hash)>

Add an action to a given request Add an action to a given request. Admin can do approve, deny, memo, and cancel operations; approver can do approve, deny and memo operations; while requester can do only cancel operation.

Parameters:

  • request_id (String) —

    Id of request

  • action (Action) —

    Action object that will be added

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

    the optional parameters

Returns:

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

    Action 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
95
 
# File 'lib/insights-approval-api-client/api/action_api.rb', line 39

def create_action_with_http_info(request_id, action, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActionApi.create_action ...'
  end
  # verify the required parameter 'request_id' is set
  if @api_client.config.client_side_validation && request_id.nil?
    fail ArgumentError, "Missing the required parameter 'request_id' when calling ActionApi.create_action"
  end
  pattern = Regexp.new(/^\d+$/)
  if @api_client.config.client_side_validation && request_id !~ pattern
    fail ArgumentError, "invalid value for 'request_id' when calling ActionApi.create_action, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'action' is set
  if @api_client.config.client_side_validation && action.nil?
    fail ArgumentError, "Missing the required parameter 'action' when calling ActionApi.create_action"
  end
  # resource path
  local_var_path = '/requests/{request_id}/actions'.sub('{' + 'request_id' + '}', CGI.escape(request_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'
  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(action) 

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

  # auth_names
  auth_names = opts[:auth_names] || ['Basic_auth']

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

#list_actions_by_request(request_id, opts = {}) ⇒ ActionCollection

List all actions of a request Return actions in a given request, available for admin/approver

Parameters:

  • request_id (String) —

    Id of request

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

    the optional parameters

Returns:



102
103
104
105
 
# File 'lib/insights-approval-api-client/api/action_api.rb', line 102

def list_actions_by_request(request_id, opts = {})
  data, _status_code, _headers = list_actions_by_request_with_http_info(request_id, opts)
  data
end

#list_actions_by_request_with_http_info(request_id, opts = {}) ⇒ Array<(ActionCollection, Integer, Hash)>

List all actions of a request Return actions in a given request, available for admin/approver

Parameters:

  • request_id (String) —

    Id of request

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

    the optional parameters

Returns:

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

    ActionCollection data, response status code and response headers



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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/insights-approval-api-client/api/action_api.rb', line 112

def list_actions_by_request_with_http_info(request_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActionApi.list_actions_by_request ...'
  end
  # verify the required parameter 'request_id' is set
  if @api_client.config.client_side_validation && request_id.nil?
    fail ArgumentError, "Missing the required parameter 'request_id' when calling ActionApi.list_actions_by_request"
  end
  pattern = Regexp.new(/^\d+$/)
  if @api_client.config.client_side_validation && request_id !~ pattern
    fail ArgumentError, "invalid value for 'request_id' when calling ActionApi.list_actions_by_request, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/requests/{request_id}/actions'.sub('{' + 'request_id' + '}', CGI.escape(request_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[:body] 

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

  # auth_names
  auth_names = opts[:auth_names] || ['Basic_auth']

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

#show_action(id, opts = {}) ⇒ Action

Return an user action by id Return an user action by id, available to all

Parameters:

  • id (String) —

    Query by id

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

    the optional parameters

Returns:



169
170
171
172
 
# File 'lib/insights-approval-api-client/api/action_api.rb', line 169

def show_action(id, opts = {})
  data, _status_code, _headers = show_action_with_http_info(id, opts)
  data
end

#show_action_with_http_info(id, opts = {}) ⇒ Array<(Action, Integer, Hash)>

Return an user action by id Return an user action by id, available to all

Parameters:

  • id (String) —

    Query by id

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

    the optional parameters

Returns:

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

    Action data, response status code and response headers



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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/insights-approval-api-client/api/action_api.rb', line 179

def show_action_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActionApi.show_action ...'
  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 ActionApi.show_action"
  end
  pattern = Regexp.new(/^\d+$/)
  if @api_client.config.client_side_validation && id !~ pattern
    fail ArgumentError, "invalid value for 'id' when calling ActionApi.show_action, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/actions/{id}'.sub('{' + 'id' + '}', CGI.escape(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(['*/*'])

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

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

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

  # auth_names
  auth_names = opts[:auth_names] || ['Basic_auth']

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