Class: MergeHRISClient::IssuesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_hris_client/api/issues_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IssuesApi

Returns a new instance of IssuesApi.



19
20
21
 
# File 'lib/merge_hris_client/api/issues_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/merge_hris_client/api/issues_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#issues_list(opts = {}) ⇒ PaginatedIssueList

Gets all issues for Organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :account_token (String)
  • :cursor (String) —

    The pagination cursor value.

  • :end_date (String) —

    If included, will only include issues whose most recent action occurred before this time

  • :end_user_organization_name (String)
  • :first_incident_time_after (Time) —

    If provided, will only return issues whose first incident time was after this datetime.

  • :first_incident_time_before (Time) —

    If provided, will only return issues whose first incident time was before this datetime.

  • :include_muted (String) —

    If true, will include muted issues

  • :integration_name (String)
  • :last_incident_time_after (Time) —

    If provided, will only return issues whose last incident time was after this datetime.

  • :last_incident_time_before (Time) —

    If provided, will only return issues whose last incident time was before this datetime.

  • :linked_account_id (String) —

    If provided, will only include issues pertaining to the linked account passed in.

  • :page_size (Integer) —

    Number of results to return per page.

  • :start_date (String) —

    If included, will only include issues whose most recent action occurred after this time

  • :status (String) —

    Status of the issue. Options: ('ONGOING', 'RESOLVED') * `ONGOING` - ONGOING * `RESOLVED` - RESOLVED

Returns:



39
40
41
42
 
# File 'lib/merge_hris_client/api/issues_api.rb', line 39

def issues_list(opts = {})
  data, _status_code, _headers = issues_list_with_http_info(opts)
  data
end

#issues_list_with_http_info(opts = {}) ⇒ Array<(PaginatedIssueList, Integer, Hash)>

Gets all issues for Organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :account_token (String)
  • :cursor (String) —

    The pagination cursor value.

  • :end_date (String) —

    If included, will only include issues whose most recent action occurred before this time

  • :end_user_organization_name (String)
  • :first_incident_time_after (Time) —

    If provided, will only return issues whose first incident time was after this datetime.

  • :first_incident_time_before (Time) —

    If provided, will only return issues whose first incident time was before this datetime.

  • :include_muted (String) —

    If true, will include muted issues

  • :integration_name (String)
  • :last_incident_time_after (Time) —

    If provided, will only return issues whose last incident time was after this datetime.

  • :last_incident_time_before (Time) —

    If provided, will only return issues whose last incident time was before this datetime.

  • :linked_account_id (String) —

    If provided, will only include issues pertaining to the linked account passed in.

  • :page_size (Integer) —

    Number of results to return per page.

  • :start_date (String) —

    If included, will only include issues whose most recent action occurred after this time

  • :status (String) —

    Status of the issue. Options: (&#39;ONGOING&#39;, &#39;RESOLVED&#39;) * &#x60;ONGOING&#x60; - ONGOING * &#x60;RESOLVED&#x60; - RESOLVED

Returns:

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

    PaginatedIssueList data, response status code and response headers



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
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
 
# File 'lib/merge_hris_client/api/issues_api.rb', line 61

def issues_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssuesApi.issues_list ...'
  end
  allowable_values = ["ONGOING", "RESOLVED"]
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
    fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/issues'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'account_token'] = opts[:'account_token'] if !opts[:'account_token'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'end_user_organization_name'] = opts[:'end_user_organization_name'] if !opts[:'end_user_organization_name'].nil?
  query_params[:'first_incident_time_after'] = opts[:'first_incident_time_after'] if !opts[:'first_incident_time_after'].nil?
  query_params[:'first_incident_time_before'] = opts[:'first_incident_time_before'] if !opts[:'first_incident_time_before'].nil?
  query_params[:'include_muted'] = opts[:'include_muted'] if !opts[:'include_muted'].nil?
  query_params[:'integration_name'] = opts[:'integration_name'] if !opts[:'integration_name'].nil?
  query_params[:'last_incident_time_after'] = opts[:'last_incident_time_after'] if !opts[:'last_incident_time_after'].nil?
  query_params[:'last_incident_time_before'] = opts[:'last_incident_time_before'] if !opts[:'last_incident_time_before'].nil?
  query_params[:'linked_account_id'] = opts[:'linked_account_id'] if !opts[:'linked_account_id'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].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] || 'PaginatedIssueList'

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

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

#issues_retrieve(id, opts = {}) ⇒ Issue

Get a specific issue.

Parameters:

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

    the optional parameters

Returns:



127
128
129
130
 
# File 'lib/merge_hris_client/api/issues_api.rb', line 127

def issues_retrieve(id, opts = {})
  data, _status_code, _headers = issues_retrieve_with_http_info(id, opts)
  data
end

#issues_retrieve_with_http_info(id, opts = {}) ⇒ Array<(Issue, Integer, Hash)>

Get a specific issue.

Parameters:

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

    the optional parameters

Returns:

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

    Issue data, response status code and response headers



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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/merge_hris_client/api/issues_api.rb', line 136

def issues_retrieve_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssuesApi.issues_retrieve ...'
  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 IssuesApi.issues_retrieve"
  end
  # resource path
  local_var_path = '/issues/{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(['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] || 'Issue'

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

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