class OpsgenieSdk::CustomUserRoleApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

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

Create Custom User Role Creates a new custom user role @param body Request payload of created custom user role @param [Hash] opts the optional parameters @return [SuccessResponse]

# File lib/opsgenie_sdk/api/custom_user_role_api.rb, line 27
def create_custom_user_role(body, opts = {})
  data, _status_code, _headers = create_custom_user_role_with_http_info(body, opts)
  data
end
create_custom_user_role_with_http_info(body, opts = {}) click to toggle source

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

# File lib/opsgenie_sdk/api/custom_user_role_api.rb, line 37
def create_custom_user_role_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomUserRoleApi.create_custom_user_role ...'
  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 CustomUserRoleApi.create_custom_user_role"
  end
  # resource path
  local_var_path = '/v2/roles'

  # 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: CustomUserRoleApi#create_custom_user_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_custom_user_role(identifier, opts = {}) click to toggle source

Delete Custom User Role Deletes a custom user role using role 'id' or 'name' @param identifier Identifier of custom user role which could be user role &#39;id&#39; or &#39;name&#39; @param [Hash] opts the optional parameters @option opts [String] :identifier_type 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) @return [SuccessResponse]

# File lib/opsgenie_sdk/api/custom_user_role_api.rb, line 80
def delete_custom_user_role(identifier, opts = {})
  data, _status_code, _headers = delete_custom_user_role_with_http_info(identifier, opts)
  data
end
delete_custom_user_role_with_http_info(identifier, opts = {}) click to toggle source

Delete Custom User Role Deletes a custom user role using role &#39;id&#39; or &#39;name&#39; @param identifier Identifier of custom user role which could be user role &#39;id&#39; or &#39;name&#39; @param [Hash] opts the optional parameters @option opts [String] :identifier_type Type of the identifier that is provided as an in-line parameter. Possible values are &#39;id&#39; or &#39;name&#39; @return [Array<(SuccessResponse, Fixnum, Hash)>] SuccessResponse data, response status code and response headers

# File lib/opsgenie_sdk/api/custom_user_role_api.rb, line 91
def delete_custom_user_role_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomUserRoleApi.delete_custom_user_role ...'
  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 CustomUserRoleApi.delete_custom_user_role"
  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/roles/{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: CustomUserRoleApi#delete_custom_user_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_custom_user_role(identifier, opts = {}) click to toggle source

Get Custom User Role Returns custom user role with given 'id' or 'name' @param identifier Identifier of custom user role which could be user role &#39;id&#39; or &#39;name&#39; @param [Hash] opts the optional parameters @option opts [String] :identifier_type 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) @return [GetCustomUserRoleResponse]

# File lib/opsgenie_sdk/api/custom_user_role_api.rb, line 138
def get_custom_user_role(identifier, opts = {})
  data, _status_code, _headers = get_custom_user_role_with_http_info(identifier, opts)
  data
end
get_custom_user_role_with_http_info(identifier, opts = {}) click to toggle source

Get Custom User Role Returns custom user role with given &#39;id&#39; or &#39;name&#39; @param identifier Identifier of custom user role which could be user role &#39;id&#39; or &#39;name&#39; @param [Hash] opts the optional parameters @option opts [String] :identifier_type Type of the identifier that is provided as an in-line parameter. Possible values are &#39;id&#39; or &#39;name&#39; @return [Array<(GetCustomUserRoleResponse, Fixnum, Hash)>] GetCustomUserRoleResponse data, response status code and response headers

# File lib/opsgenie_sdk/api/custom_user_role_api.rb, line 149
def get_custom_user_role_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomUserRoleApi.get_custom_user_role ...'
  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 CustomUserRoleApi.get_custom_user_role"
  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/roles/{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 => 'GetCustomUserRoleResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomUserRoleApi#get_custom_user_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_custom_user_roles(opts = {}) click to toggle source

List Custom User Roles Returns list of custom user roles @param [Hash] opts the optional parameters @return [ListCustomUserRolesResponse]

# File lib/opsgenie_sdk/api/custom_user_role_api.rb, line 194
def list_custom_user_roles(opts = {})
  data, _status_code, _headers = list_custom_user_roles_with_http_info(opts)
  data
end
list_custom_user_roles_with_http_info(opts = {}) click to toggle source

List Custom User Roles Returns list of custom user roles @param [Hash] opts the optional parameters @return [Array<(ListCustomUserRolesResponse, Fixnum, Hash)>] ListCustomUserRolesResponse data, response status code and response headers

# File lib/opsgenie_sdk/api/custom_user_role_api.rb, line 203
def list_custom_user_roles_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomUserRoleApi.list_custom_user_roles ...'
  end
  # resource path
  local_var_path = '/v2/roles'

  # 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 => 'ListCustomUserRolesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomUserRoleApi#list_custom_user_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_custom_user_role(identifier, opts = {}) click to toggle source

Update Custom User Role Updates the custom user role using role 'id' or 'name' @param identifier Identifier of custom user role which could be user role &#39;id&#39; or &#39;name&#39; @param [Hash] opts the optional parameters @option opts [String] :identifier_type 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) @option opts [UpdateCustomUserRolePayload] :body Request payload of update custom user role @return [SuccessResponse]

# File lib/opsgenie_sdk/api/custom_user_role_api.rb, line 243
def update_custom_user_role(identifier, opts = {})
  data, _status_code, _headers = update_custom_user_role_with_http_info(identifier, opts)
  data
end
update_custom_user_role_with_http_info(identifier, opts = {}) click to toggle source

Update Custom User Role Updates the custom user role using role &#39;id&#39; or &#39;name&#39; @param identifier Identifier of custom user role which could be user role &#39;id&#39; or &#39;name&#39; @param [Hash] opts the optional parameters @option opts [String] :identifier_type Type of the identifier that is provided as an in-line parameter. Possible values are &#39;id&#39; or &#39;name&#39; @option opts [UpdateCustomUserRolePayload] :body Request payload of update custom user role @return [Array<(SuccessResponse, Fixnum, Hash)>] SuccessResponse data, response status code and response headers

# File lib/opsgenie_sdk/api/custom_user_role_api.rb, line 255
def update_custom_user_role_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomUserRoleApi.update_custom_user_role ...'
  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 CustomUserRoleApi.update_custom_user_role"
  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/roles/{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(:PUT, 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: CustomUserRoleApi#update_custom_user_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end