Class: OpsgenieSdk::ServiceApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ServiceApi

Returns a new instance of ServiceApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_service(body, opts = {}) ⇒ SuccessResponse

Create Service Creates a new service

Parameters:

  • body —

    Request payload of created service

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

    the optional parameters

Returns:



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

def create_service(body, opts = {})
  data, _status_code, _headers = create_service_with_http_info(body, opts)
  data
end

#create_service_with_http_info(body, opts = {}) ⇒ Array<(SuccessResponse, Fixnum, Hash)>

Create Service Creates a new service

Parameters:

  • body —

    Request payload of created service

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

    the optional parameters

Returns:

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

    SuccessResponse 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/service_api.rb', line 37

def create_service_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceApi.create_service ...'
  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 ServiceApi.create_service"
  end
  # resource path
  local_var_path = '/v1/services'

  # 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 => 'SuccessResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServiceApi#create_service\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete Service Delete service with given id

Parameters:

  • identifier —

    Identifier of the service

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

    the optional parameters

Returns:



79
80
81
82
 
# File 'lib/opsgenie_sdk/api/service_api.rb', line 79

def delete_service(identifier, opts = {})
  data, _status_code, _headers = delete_service_with_http_info(identifier, opts)
  data
end

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

Delete Service Delete service with given id

Parameters:

  • identifier —

    Identifier of the service

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

    the optional parameters

Returns:

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

    SuccessResponse data, response status code and response headers



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
122
123
124
125
 
# File 'lib/opsgenie_sdk/api/service_api.rb', line 89

def delete_service_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceApi.delete_service ...'
  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 ServiceApi.delete_service"
  end
  # resource path
  local_var_path = '/v1/services/{identifier}'.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(['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: ServiceApi#delete_service\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_service(identifier, opts = {}) ⇒ GetServiceResponse

Get Service Returns service with given ‘id’

Parameters:

  • identifier —

    Identifier of the service

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

    the optional parameters

Returns:

  • (GetServiceResponse) 


131
132
133
134
 
# File 'lib/opsgenie_sdk/api/service_api.rb', line 131

def get_service(identifier, opts = {})
  data, _status_code, _headers = get_service_with_http_info(identifier, opts)
  data
end

#get_service_with_http_info(identifier, opts = {}) ⇒ Array<(GetServiceResponse, Fixnum, Hash)>

Get Service Returns service with given &#39;id&#39;

Parameters:

  • identifier —

    Identifier of the service

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

    the optional parameters

Returns:

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

    GetServiceResponse data, response status code and response headers



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

def get_service_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceApi.get_service ...'
  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 ServiceApi.get_service"
  end
  # resource path
  local_var_path = '/v1/services/{identifier}'.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(['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 => 'GetServiceResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServiceApi#get_service\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_services(opts = {}) ⇒ ListServicesResponse

List services Return list of services

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of users to retrieve (default to 100)

  • :offset (Integer) —

    Number of users to skip from start (default to 0)

  • :sort_field (String) —

    Field to use in sorting. Should be one of &#39;username&#39;, &#39;fullName&#39; and &#39;insertedAt&#39;

  • :order (String) —

    Direction of sorting. Should be one of &#39;asc&#39; or &#39;desc&#39; (default to asc)

  • :query (String) —

    Field:value combinations with most of user fields to make more advanced searches. Possible fields are username, fullName, blocked, verified, role, locale, timeZone, userAddress and createdAt

Returns:



187
188
189
190
 
# File 'lib/opsgenie_sdk/api/service_api.rb', line 187

def list_services(opts = {})
  data, _status_code, _headers = list_services_with_http_info(opts)
  data
end

#list_services_with_http_info(opts = {}) ⇒ Array<(ListServicesResponse, Fixnum, Hash)>

List services Return list of services

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of users to retrieve

  • :offset (Integer) —

    Number of users to skip from start

  • :sort_field (String) —

    Field to use in sorting. Should be one of &#39;username&#39;, &#39;fullName&#39; and &#39;insertedAt&#39;

  • :order (String) —

    Direction of sorting. Should be one of &#39;asc&#39; or &#39;desc&#39;

  • :query (String) —

    Field:value combinations with most of user fields to make more advanced searches. Possible fields are username, fullName, blocked, verified, role, locale, timeZone, userAddress and createdAt

Returns:

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

    ListServicesResponse data, response status code and response headers



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
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/opsgenie_sdk/api/service_api.rb', line 201

def list_services_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceApi.list_services ...'
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['asc', 'desc'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of asc, desc'
  end
  # resource path
  local_var_path = '/v1/services'

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'sortField'] = opts[:'sort_field'] if !opts[:'sort_field'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].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 => 'ListServicesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServiceApi#list_services\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update Service (Partial) Update service with given id

Parameters:

  • identifier —

    Identifier of the service

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

    the optional parameters

Options Hash (opts):

  • :body (UpdateServicePayload) —

    Request payload of update service action

Returns:



248
249
250
251
 
# File 'lib/opsgenie_sdk/api/service_api.rb', line 248

def update_service(identifier, opts = {})
  data, _status_code, _headers = update_service_with_http_info(identifier, opts)
  data
end

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

Update Service (Partial) Update service with given id

Parameters:

  • identifier —

    Identifier of the service

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

    the optional parameters

Options Hash (opts):

  • :body (UpdateServicePayload) —

    Request payload of update service action

Returns:

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

    SuccessResponse data, response status code and response headers



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/opsgenie_sdk/api/service_api.rb', line 259

def update_service_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceApi.update_service ...'
  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 ServiceApi.update_service"
  end
  # resource path
  local_var_path = '/v1/services/{identifier}'.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(['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 => 'SuccessResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServiceApi#update_service\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end