Class: OpsgenieSdk::WhoIsOnCallApi

Inherits:
Object
  • Object
show all
Defined in:
lib/opsgenie_sdk/api/who_is_on_call_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WhoIsOnCallApi

Returns a new instance of WhoIsOnCallApi.



19
20
21
 
# File 'lib/opsgenie_sdk/api/who_is_on_call_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/opsgenie_sdk/api/who_is_on_call_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#export_on_call_user(identifier, opts = {}) ⇒ String

Export On-Call User Exports personal on-call timeline of 3 months to a .ics file

Parameters:

  • identifier —

    Identifier of the user. Should be either 'id' or 'username' of the user

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

    the optional parameters

Returns:

  • (String) 


27
28
29
30
 
# File 'lib/opsgenie_sdk/api/who_is_on_call_api.rb', line 27

def export_on_call_user(identifier, opts = {})
  data, _status_code, _headers = export_on_call_user_with_http_info(identifier, opts)
  data
end

#export_on_call_user_with_http_info(identifier, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Export On-Call User Exports personal on-call timeline of 3 months to a .ics file

Parameters:

  • identifier —

    Identifier of the user. Should be either &#39;id&#39; or &#39;username&#39; of the user

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

    the optional parameters

Returns:

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

    String 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
 
# File 'lib/opsgenie_sdk/api/who_is_on_call_api.rb', line 37

def export_on_call_user_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WhoIsOnCallApi.export_on_call_user ...'
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling WhoIsOnCallApi.export_on_call_user"
  end
  # resource path
  local_var_path = '/v2/schedules/on-calls/{identifier}.ics'.sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/calendar'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['GenieKey']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WhoIsOnCallApi#export_on_call_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_next_on_calls(identifier, opts = {}) ⇒ GetNextOnCallResponse

Get Next On Calls Gets next on-call participants of a specific schedule

Parameters:

  • identifier —

    Identifier of schedule which could be id or name

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

    the optional parameters

Options Hash (opts):

  • :schedule_identifier_type (String) —

    Type of the identifier that is provided as an in-line parameter. Possible values are &#39;id&#39; or &#39;name&#39; (default to id)

  • :flat (BOOLEAN) —

    Retrieves user names of all on call participants if enabled

  • :date (DateTime) —

    Starting date of the timeline

Returns:



82
83
84
85
 
# File 'lib/opsgenie_sdk/api/who_is_on_call_api.rb', line 82

def get_next_on_calls(identifier, opts = {})
  data, _status_code, _headers = get_next_on_calls_with_http_info(identifier, opts)
  data
end

#get_next_on_calls_with_http_info(identifier, opts = {}) ⇒ Array<(GetNextOnCallResponse, Fixnum, Hash)>

Get Next On Calls Gets next on-call participants of a specific schedule

Parameters:

  • identifier —

    Identifier of schedule which could be id or name

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

    the optional parameters

Options Hash (opts):

  • :schedule_identifier_type (String) —

    Type of the identifier that is provided as an in-line parameter. Possible values are &#39;id&#39; or &#39;name&#39;

  • :flat (BOOLEAN) —

    Retrieves user names of all on call participants if enabled

  • :date (DateTime) —

    Starting date of the timeline

Returns:

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

    GetNextOnCallResponse data, response status code and response headers



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
136
137
 
# File 'lib/opsgenie_sdk/api/who_is_on_call_api.rb', line 95

def get_next_on_calls_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WhoIsOnCallApi.get_next_on_calls ...'
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling WhoIsOnCallApi.get_next_on_calls"
  end
  if @api_client.config.client_side_validation && opts[:'schedule_identifier_type'] && !['id', 'name'].include?(opts[:'schedule_identifier_type'])
    fail ArgumentError, 'invalid value for "schedule_identifier_type", must be one of id, name'
  end
  # resource path
  local_var_path = '/v2/schedules/{identifier}/next-on-calls'.sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'scheduleIdentifierType'] = opts[:'schedule_identifier_type'] if !opts[:'schedule_identifier_type'].nil?
  query_params[:'flat'] = opts[:'flat'] if !opts[:'flat'].nil?
  query_params[:'date'] = opts[:'date'] if !opts[:'date'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['GenieKey']
  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 => 'GetNextOnCallResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WhoIsOnCallApi#get_next_on_calls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_on_calls(identifier, opts = {}) ⇒ GetOnCallResponse

Get On Calls Gets current on-call participants of a specific schedule

Parameters:

  • identifier —

    Identifier of schedule which could be id or name

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

    the optional parameters

Options Hash (opts):

  • :schedule_identifier_type (String) —

    Type of the identifier that is provided as an in-line parameter. Possible values are &#39;id&#39; or &#39;name&#39; (default to id)

  • :flat (BOOLEAN) —

    Retrieves user names of all on call participants if enabled

  • :date (DateTime) —

    Starting date of the timeline

Returns:



146
147
148
149
 
# File 'lib/opsgenie_sdk/api/who_is_on_call_api.rb', line 146

def get_on_calls(identifier, opts = {})
  data, _status_code, _headers = get_on_calls_with_http_info(identifier, opts)
  data
end

#get_on_calls_with_http_info(identifier, opts = {}) ⇒ Array<(GetOnCallResponse, Fixnum, Hash)>

Get On Calls Gets current on-call participants of a specific schedule

Parameters:

  • identifier —

    Identifier of schedule which could be id or name

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

    the optional parameters

Options Hash (opts):

  • :schedule_identifier_type (String) —

    Type of the identifier that is provided as an in-line parameter. Possible values are &#39;id&#39; or &#39;name&#39;

  • :flat (BOOLEAN) —

    Retrieves user names of all on call participants if enabled

  • :date (DateTime) —

    Starting date of the timeline

Returns:

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

    GetOnCallResponse data, response status code and response headers



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
195
196
197
198
199
200
201
 
# File 'lib/opsgenie_sdk/api/who_is_on_call_api.rb', line 159

def get_on_calls_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WhoIsOnCallApi.get_on_calls ...'
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling WhoIsOnCallApi.get_on_calls"
  end
  if @api_client.config.client_side_validation && opts[:'schedule_identifier_type'] && !['id', 'name'].include?(opts[:'schedule_identifier_type'])
    fail ArgumentError, 'invalid value for "schedule_identifier_type", must be one of id, name'
  end
  # resource path
  local_var_path = '/v2/schedules/{identifier}/on-calls'.sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'scheduleIdentifierType'] = opts[:'schedule_identifier_type'] if !opts[:'schedule_identifier_type'].nil?
  query_params[:'flat'] = opts[:'flat'] if !opts[:'flat'].nil?
  query_params[:'date'] = opts[:'date'] if !opts[:'date'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['GenieKey']
  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 => 'GetOnCallResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WhoIsOnCallApi#get_on_calls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_on_calls(opts = {}) ⇒ ListOnCallsResponse

List On Calls Lists current on-call participants of all schedules

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :flat (BOOLEAN) —

    Retrieves user names of all on call participants if enabled

  • :date (DateTime) —

    Starting date of the timeline

Returns:



208
209
210
211
 
# File 'lib/opsgenie_sdk/api/who_is_on_call_api.rb', line 208

def list_on_calls(opts = {})
  data, _status_code, _headers = list_on_calls_with_http_info(opts)
  data
end

#list_on_calls_with_http_info(opts = {}) ⇒ Array<(ListOnCallsResponse, Fixnum, Hash)>

List On Calls Lists current on-call participants of all schedules

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :flat (BOOLEAN) —

    Retrieves user names of all on call participants if enabled

  • :date (DateTime) —

    Starting date of the timeline

Returns:

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

    ListOnCallsResponse data, response status code and response headers



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
 
# File 'lib/opsgenie_sdk/api/who_is_on_call_api.rb', line 219

def list_on_calls_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WhoIsOnCallApi.list_on_calls ...'
  end
  # resource path
  local_var_path = '/v2/schedules/on-calls'

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['GenieKey']
  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 => 'ListOnCallsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WhoIsOnCallApi#list_on_calls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end