Class: OpsgenieSdk::ScheduleApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ScheduleApi

Returns a new instance of ScheduleApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_schedule(body, opts = {}) ⇒ CreateScheduleResponse

Create Schedule Creates a new schedule

Parameters:

  • body —

    Request payload of created schedule

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

    the optional parameters

Returns:



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

def create_schedule(body, opts = {})
  data, _status_code, _headers = create_schedule_with_http_info(body, opts)
  data
end

#create_schedule_with_http_info(body, opts = {}) ⇒ Array<(CreateScheduleResponse, Fixnum, Hash)>

Create Schedule Creates a new schedule

Parameters:

  • body —

    Request payload of created schedule

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

    the optional parameters

Returns:

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

    CreateScheduleResponse 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/schedule_api.rb', line 37

def create_schedule_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScheduleApi.create_schedule ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ScheduleApi.create_schedule"
  end
  # resource path
  local_var_path = '/v2/schedules'

  # query parameters
  query_params = {}

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

#delete_schedule(identifier, opts = {}) ⇒ SuccessResponse

Delete Schedule Delete schedule with given identifier

Parameters:

  • identifier —

    Identifier of schedule which could be id or name

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

    the optional parameters

Options Hash (opts):

  • :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)

Returns:



80
81
82
83
 
# File 'lib/opsgenie_sdk/api/schedule_api.rb', line 80

def delete_schedule(identifier, opts = {})
  data, _status_code, _headers = delete_schedule_with_http_info(identifier, opts)
  data
end

#delete_schedule_with_http_info(identifier, opts = {}) ⇒ Array<(SuccessResponse, Fixnum, Hash)>

Delete Schedule Delete schedule with given identifier

Parameters:

  • identifier —

    Identifier of schedule which could be id or name

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

    the optional parameters

Options Hash (opts):

  • :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;

Returns:

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

    SuccessResponse data, response status code and response headers



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
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/opsgenie_sdk/api/schedule_api.rb', line 91

def delete_schedule_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScheduleApi.delete_schedule ...'
  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 ScheduleApi.delete_schedule"
  end
  if @api_client.config.client_side_validation && opts[:'identifier_type'] && !['id', 'name'].include?(opts[:'identifier_type'])
    fail ArgumentError, 'invalid value for "identifier_type", must be one of id, name'
  end
  # resource path
  local_var_path = '/v2/schedules/{identifier}'.sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'identifierType'] = opts[:'identifier_type'] if !opts[:'identifier_type'].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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SuccessResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScheduleApi#delete_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Export Schedule Returns an .ics file as byte array

Parameters:

  • identifier —

    Identifier of schedule which could be id or name

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

    the optional parameters

Options Hash (opts):

  • :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)

Returns:

  • (String) 


138
139
140
141
 
# File 'lib/opsgenie_sdk/api/schedule_api.rb', line 138

def export_schedule(identifier, opts = {})
  data, _status_code, _headers = export_schedule_with_http_info(identifier, opts)
  data
end

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

Export Schedule Returns an .ics file as byte array

Parameters:

  • identifier —

    Identifier of schedule which could be id or name

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

    the optional parameters

Options Hash (opts):

  • :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;

Returns:

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

    String data, response status code and response headers



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
183
184
185
186
187
188
189
 
# File 'lib/opsgenie_sdk/api/schedule_api.rb', line 149

def export_schedule_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScheduleApi.export_schedule ...'
  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 ScheduleApi.export_schedule"
  end
  if @api_client.config.client_side_validation && opts[:'identifier_type'] && !['id', 'name'].include?(opts[:'identifier_type'])
    fail ArgumentError, 'invalid value for "identifier_type", must be one of id, name'
  end
  # resource path
  local_var_path = '/v2/schedules/{identifier}.ics'.sub('{' + 'identifier' + '}', identifier.to_s)

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

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

#get_schedule(identifier, opts = {}) ⇒ GetScheduleResponse

Get Schedule Returns schedule with given id or name

Parameters:

  • identifier —

    Identifier of schedule which could be id or name

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

    the optional parameters

Options Hash (opts):

  • :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)

Returns:



196
197
198
199
 
# File 'lib/opsgenie_sdk/api/schedule_api.rb', line 196

def get_schedule(identifier, opts = {})
  data, _status_code, _headers = get_schedule_with_http_info(identifier, opts)
  data
end

#get_schedule_timeline(identifier, opts = {}) ⇒ GetScheduleTimelineResponse

Get Schedule Timeline Returns schedule timeline with given id or name

Parameters:

  • identifier —

    Identifier of schedule which could be id or name

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

    the optional parameters

Options Hash (opts):

  • :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)

  • :expand (Array<String>) —

    Returns more detailed response with expanding it. Possible values are &#39;base&#39;, &#39;forwarding&#39;, and &#39;override&#39; which is also returned with expandable field of response

  • :interval (Integer) —

    Length of time as integer in intervalUnits to retrieve the timeline. Default value is 1 (default to 1)

  • :interval_unit (String) —

    Unit of the time to retrieve the timeline. Available values are &#39;days&#39;, &#39;weeks&#39; and &#39;months&#39;. Default value is &#39;weeks&#39;

  • :date (DateTime) —

    Time to return future date on-call participants. Default date is the moment of the time that request is received

Returns:



258
259
260
261
 
# File 'lib/opsgenie_sdk/api/schedule_api.rb', line 258

def get_schedule_timeline(identifier, opts = {})
  data, _status_code, _headers = get_schedule_timeline_with_http_info(identifier, opts)
  data
end

#get_schedule_timeline_with_http_info(identifier, opts = {}) ⇒ Array<(GetScheduleTimelineResponse, Fixnum, Hash)>

Get Schedule Timeline Returns schedule timeline with given id or name

Parameters:

  • identifier —

    Identifier of schedule which could be id or name

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

    the optional parameters

Options Hash (opts):

  • :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;

  • :expand (Array<String>) —

    Returns more detailed response with expanding it. Possible values are &#39;base&#39;, &#39;forwarding&#39;, and &#39;override&#39; which is also returned with expandable field of response

  • :interval (Integer) —

    Length of time as integer in intervalUnits to retrieve the timeline. Default value is 1

  • :interval_unit (String) —

    Unit of the time to retrieve the timeline. Available values are &#39;days&#39;, &#39;weeks&#39; and &#39;months&#39;. Default value is &#39;weeks&#39;

  • :date (DateTime) —

    Time to return future date on-call participants. Default date is the moment of the time that request is received

Returns:



273
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
320
 
# File 'lib/opsgenie_sdk/api/schedule_api.rb', line 273

def get_schedule_timeline_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScheduleApi.get_schedule_timeline ...'
  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 ScheduleApi.get_schedule_timeline"
  end
  if @api_client.config.client_side_validation && opts[:'identifier_type'] && !['id', 'name'].include?(opts[:'identifier_type'])
    fail ArgumentError, 'invalid value for "identifier_type", must be one of id, name'
  end
  if @api_client.config.client_side_validation && opts[:'interval_unit'] && !['days', 'weeks', 'months'].include?(opts[:'interval_unit'])
    fail ArgumentError, 'invalid value for "interval_unit", must be one of days, weeks, months'
  end
  # resource path
  local_var_path = '/v2/schedules/{identifier}/timeline'.sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'identifierType'] = opts[:'identifier_type'] if !opts[:'identifier_type'].nil?
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :csv) if !opts[:'expand'].nil?
  query_params[:'interval'] = opts[:'interval'] if !opts[:'interval'].nil?
  query_params[:'intervalUnit'] = opts[:'interval_unit'] if !opts[:'interval_unit'].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 => 'GetScheduleTimelineResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScheduleApi#get_schedule_timeline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_schedule_with_http_info(identifier, opts = {}) ⇒ Array<(GetScheduleResponse, Fixnum, Hash)>

Get Schedule Returns schedule with given id or name

Parameters:

  • identifier —

    Identifier of schedule which could be id or name

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

    the optional parameters

Options Hash (opts):

  • :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;

Returns:

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

    GetScheduleResponse data, response status code and response headers



207
208
209
210
211
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
 
# File 'lib/opsgenie_sdk/api/schedule_api.rb', line 207

def get_schedule_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScheduleApi.get_schedule ...'
  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 ScheduleApi.get_schedule"
  end
  if @api_client.config.client_side_validation && opts[:'identifier_type'] && !['id', 'name'].include?(opts[:'identifier_type'])
    fail ArgumentError, 'invalid value for "identifier_type", must be one of id, name'
  end
  # resource path
  local_var_path = '/v2/schedules/{identifier}'.sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'identifierType'] = opts[:'identifier_type'] if !opts[:'identifier_type'].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 => 'GetScheduleResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScheduleApi#get_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_schedules(opts = {}) ⇒ ListSchedulesResponse

List Schedules Returns list of schedule

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Returns more detailed response with expanding it. Possible value is &#39;rotation&#39; which is also returned with expandable field of response

Returns:



326
327
328
329
 
# File 'lib/opsgenie_sdk/api/schedule_api.rb', line 326

def list_schedules(opts = {})
  data, _status_code, _headers = list_schedules_with_http_info(opts)
  data
end

#list_schedules_with_http_info(opts = {}) ⇒ Array<(ListSchedulesResponse, Fixnum, Hash)>

List Schedules Returns list of schedule

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Returns more detailed response with expanding it. Possible value is &#39;rotation&#39; which is also returned with expandable field of response

Returns:

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

    ListSchedulesResponse data, response status code and response headers



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/opsgenie_sdk/api/schedule_api.rb', line 336

def list_schedules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScheduleApi.list_schedules ...'
  end
  # resource path
  local_var_path = '/v2/schedules'

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :csv) if !opts[:'expand'].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 => 'ListSchedulesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScheduleApi#list_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_schedule(identifier, opts = {}) ⇒ UpdateScheduleResponse

Update Schedule (Partial) Update schedule with given id or name

Parameters:

  • identifier —

    Identifier of schedule which could be id or name

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

    the optional parameters

Options Hash (opts):

  • :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)

  • :body (UpdateSchedulePayload) —

    Request payload of update schedule action

Returns:



377
378
379
380
 
# File 'lib/opsgenie_sdk/api/schedule_api.rb', line 377

def update_schedule(identifier, opts = {})
  data, _status_code, _headers = update_schedule_with_http_info(identifier, opts)
  data
end

#update_schedule_with_http_info(identifier, opts = {}) ⇒ Array<(UpdateScheduleResponse, Fixnum, Hash)>

Update Schedule (Partial) Update schedule with given id or name

Parameters:

  • identifier —

    Identifier of schedule which could be id or name

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

    the optional parameters

Options Hash (opts):

  • :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;

  • :body (UpdateSchedulePayload) —

    Request payload of update schedule action

Returns:

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

    UpdateScheduleResponse data, response status code and response headers



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/opsgenie_sdk/api/schedule_api.rb', line 389

def update_schedule_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScheduleApi.update_schedule ...'
  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 ScheduleApi.update_schedule"
  end
  if @api_client.config.client_side_validation && opts[:'identifier_type'] && !['id', 'name'].include?(opts[:'identifier_type'])
    fail ArgumentError, 'invalid value for "identifier_type", must be one of id, name'
  end
  # resource path
  local_var_path = '/v2/schedules/{identifier}'.sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'identifierType'] = opts[:'identifier_type'] if !opts[:'identifier_type'].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 = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['GenieKey']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UpdateScheduleResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScheduleApi#update_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end