Class: EmassClient::PACApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PACApi

Returns a new instance of PACApi.



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

def api_client
  @api_client
end

Instance Method Details

#add_system_pac(system_id, request_body, opts = {}) ⇒ PacResponsePost

Initiate system workflow for review Adds a Package Approval Chain (PAC) for given ‘systemId` path parameter **Request Body Required Fields** - `workflow` - `name` - `comments`

Parameters:

  • system_id (Integer) —

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

  • request_body (Array<Object>) —

    Add system package to PAC for review

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

    the optional parameters

Returns:



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

def add_system_pac(system_id, request_body, opts = {})
  data, _status_code, _headers = add_system_pac_with_http_info(system_id, request_body, opts)
  data
end

#add_system_pac_with_http_info(system_id, request_body, opts = {}) ⇒ Array<(PacResponsePost, Integer, Hash)>

Initiate system workflow for review Adds a Package Approval Chain (PAC) for given &#x60;systemId&#x60; path parameter **Request Body Required Fields** - &#x60;workflow&#x60; - &#x60;name&#x60; - &#x60;comments&#x60;

Parameters:

  • system_id (Integer) —

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

  • request_body (Array<Object>) —

    Add system package to PAC for review

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

    the optional parameters

Returns:

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

    PacResponsePost 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/pac_api.rb', line 39

def add_system_pac_with_http_info(system_id, request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PACApi.add_system_pac ...'
  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 PACApi.add_system_pac"
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling PACApi.add_system_pac"
  end
  # resource path
  local_var_path = '/api/systems/{systemId}/approval/pac'.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'])
  # 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(request_body)

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

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

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

#get_system_pac(system_id, opts = {}) ⇒ PacResponseGet

Get status of active workflows in a system Returns the location of a system’s package in the Package Approval Chain (PAC) for matching ‘systemId` path parameter Notes: - If the indicated system has any active workflows, the response will include information such as the workflow type and the current stage of each workflow. - If there are no active workflows, then a null data member will be returned.

Parameters:

  • system_id (Integer) —

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

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

    the optional parameters

Returns:



101
102
103
104
 
# File 'lib/emass_client/api/pac_api.rb', line 101

def get_system_pac(system_id, opts = {})
  data, _status_code, _headers = get_system_pac_with_http_info(system_id, opts)
  data
end

#get_system_pac_with_http_info(system_id, opts = {}) ⇒ Array<(PacResponseGet, Integer, Hash)>

Get status of active workflows in a system Returns the location of a system&#39;s package in the Package Approval Chain (PAC) for matching &#x60;systemId&#x60; path parameter Notes: - If the indicated system has any active workflows, the response will include information such as the workflow type and the current stage of each workflow. - If there are no active workflows, then a null data member will be returned.

Parameters:

  • system_id (Integer) —

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

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

    the optional parameters

Returns:

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

    PacResponseGet data, response status code and response headers



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
149
150
151
152
153
154
155
156
157
 
# File 'lib/emass_client/api/pac_api.rb', line 111

def get_system_pac_with_http_info(system_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PACApi.get_system_pac ...'
  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 PACApi.get_system_pac"
  end
  # resource path
  local_var_path = '/api/systems/{systemId}/approval/pac'.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'])

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

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

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

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

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