class OpsgenieSdk::ServiceApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/opsgenie_sdk/api/service_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

create_service(body, opts = {}) click to toggle source

Create Service Creates a new service @param body Request payload of created service @param [Hash] opts the optional parameters @return [SuccessResponse]

# 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 = {}) click to toggle source

Create Service Creates a new service @param body Request payload of created service @param [Hash] opts the optional parameters @return [Array<(SuccessResponse, Fixnum, Hash)>] SuccessResponse data, response status code and response headers

# 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 = {}) click to toggle source

Delete Service Delete service with given id @param identifier Identifier of the service @param [Hash] opts the optional parameters @return [SuccessResponse]

# 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 = {}) click to toggle source

Delete Service Delete service with given id @param identifier Identifier of the service @param [Hash] opts the optional parameters @return [Array<(SuccessResponse, Fixnum, Hash)>] SuccessResponse data, response status code and response headers

# 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 = {}) click to toggle source

Get Service Returns service with given 'id' @param identifier Identifier of the service @param [Hash] opts the optional parameters @return [GetServiceResponse]

# 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 = {}) click to toggle source

Get Service Returns service with given &#39;id&#39; @param identifier Identifier of the service @param [Hash] opts the optional parameters @return [Array<(GetServiceResponse, Fixnum, Hash)>] GetServiceResponse data, response status code and response headers

# 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 = {}) click to toggle source

List services Return list of services @param [Hash] opts the optional parameters @option opts [Integer] :limit Number of users to retrieve (default to 100) @option opts [Integer] :offset Number of users to skip from start (default to 0) @option opts [String] :sort_field Field to use in sorting. Should be one of &#39;username&#39;, &#39;fullName&#39; and &#39;insertedAt&#39; @option opts [String] :order Direction of sorting. Should be one of &#39;asc&#39; or &#39;desc&#39; (default to asc) @option opts [String] :query 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 @return [ListServicesResponse]

# 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 = {}) click to toggle source

List services Return list of services @param [Hash] opts the optional parameters @option opts [Integer] :limit Number of users to retrieve @option opts [Integer] :offset Number of users to skip from start @option opts [String] :sort_field Field to use in sorting. Should be one of &#39;username&#39;, &#39;fullName&#39; and &#39;insertedAt&#39; @option opts [String] :order Direction of sorting. Should be one of &#39;asc&#39; or &#39;desc&#39; @option opts [String] :query 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 @return [Array<(ListServicesResponse, Fixnum, Hash)>] ListServicesResponse data, response status code and response headers

# 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 = {}) click to toggle source

Update Service (Partial) Update service with given id @param identifier Identifier of the service @param [Hash] opts the optional parameters @option opts [UpdateServicePayload] :body Request payload of update service action @return [SuccessResponse]

# 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 = {}) click to toggle source

Update Service (Partial) Update service with given id @param identifier Identifier of the service @param [Hash] opts the optional parameters @option opts [UpdateServicePayload] :body Request payload of update service action @return [Array<(SuccessResponse, Fixnum, Hash)>] SuccessResponse data, response status code and response headers

# 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