class OpsgenieSdk::TeamRoutingRuleApi
Attributes
Public Class Methods
# File lib/opsgenie_sdk/api/team_routing_rule_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Change Team
Routing Rule Order Change the order of team routing rule with given id @param identifier Identifier of the team @param id Id of the team routing rule @param body Request payload of change team routing rule order action @param [Hash] opts the optional parameters @option opts [String] :team_identifier_type Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id' (default to id) @return [SuccessResponse]
# File lib/opsgenie_sdk/api/team_routing_rule_api.rb, line 30 def change_team_routing_rule_order(identifier, id, body, opts = {}) data, _status_code, _headers = change_team_routing_rule_order_with_http_info(identifier, id, body, opts) data end
Change Team
Routing Rule Order Change the order of team routing rule with given id @param identifier Identifier of the team @param id Id of the team routing rule @param body Request payload of change team routing rule order action @param [Hash] opts the optional parameters @option opts [String] :team_identifier_type Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id' @return [Array<(SuccessResponse
, Fixnum, Hash)>] SuccessResponse
data, response status code and response headers
# File lib/opsgenie_sdk/api/team_routing_rule_api.rb, line 43 def change_team_routing_rule_order_with_http_info(identifier, id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TeamRoutingRuleApi.change_team_routing_rule_order ...' 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 TeamRoutingRuleApi.change_team_routing_rule_order" end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling TeamRoutingRuleApi.change_team_routing_rule_order" 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 TeamRoutingRuleApi.change_team_routing_rule_order" end if @api_client.config.client_side_validation && opts[:'team_identifier_type'] && !['id', 'name'].include?(opts[:'team_identifier_type']) fail ArgumentError, 'invalid value for "team_identifier_type", must be one of id, name' end # resource path local_var_path = '/v2/teams/{identifier}/routing-rules/{id}/change-order'.sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} query_params[:'teamIdentifierType'] = opts[:'team_identifier_type'] if !opts[:'team_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(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: TeamRoutingRuleApi#change_team_routing_rule_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create Team
Routing Rule Creates a new team routing rule @param identifier Identifier of the team @param body Request payload of createTeamRoutingRule @param [Hash] opts the optional parameters @option opts [String] :team_identifier_type Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id' (default to id) @return [SuccessResponse]
# File lib/opsgenie_sdk/api/team_routing_rule_api.rb, line 99 def create_team_routing_rule(identifier, body, opts = {}) data, _status_code, _headers = create_team_routing_rule_with_http_info(identifier, body, opts) data end
Create Team
Routing Rule Creates a new team routing rule @param identifier Identifier of the team @param body Request payload of createTeamRoutingRule @param [Hash] opts the optional parameters @option opts [String] :team_identifier_type Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id' @return [Array<(SuccessResponse
, Fixnum, Hash)>] SuccessResponse
data, response status code and response headers
# File lib/opsgenie_sdk/api/team_routing_rule_api.rb, line 111 def create_team_routing_rule_with_http_info(identifier, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TeamRoutingRuleApi.create_team_routing_rule ...' 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 TeamRoutingRuleApi.create_team_routing_rule" 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 TeamRoutingRuleApi.create_team_routing_rule" end if @api_client.config.client_side_validation && opts[:'team_identifier_type'] && !['id', 'name'].include?(opts[:'team_identifier_type']) fail ArgumentError, 'invalid value for "team_identifier_type", must be one of id, name' end # resource path local_var_path = '/v2/teams/{identifier}/routing-rules'.sub('{' + 'identifier' + '}', identifier.to_s) # query parameters query_params = {} query_params[:'teamIdentifierType'] = opts[:'team_identifier_type'] if !opts[:'team_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(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: TeamRoutingRuleApi#create_team_routing_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete Team
Routing Rule Delete team routing rule with given id @param identifier Identifier of the team @param id Id of the team routing rule @param [Hash] opts the optional parameters @option opts [String] :team_identifier_type Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id' (default to id) @return [SuccessResponse]
# File lib/opsgenie_sdk/api/team_routing_rule_api.rb, line 163 def delete_team_routing_rule(identifier, id, opts = {}) data, _status_code, _headers = delete_team_routing_rule_with_http_info(identifier, id, opts) data end
Delete Team
Routing Rule Delete team routing rule with given id @param identifier Identifier of the team @param id Id of the team routing rule @param [Hash] opts the optional parameters @option opts [String] :team_identifier_type Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id' @return [Array<(SuccessResponse
, Fixnum, Hash)>] SuccessResponse
data, response status code and response headers
# File lib/opsgenie_sdk/api/team_routing_rule_api.rb, line 175 def delete_team_routing_rule_with_http_info(identifier, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TeamRoutingRuleApi.delete_team_routing_rule ...' 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 TeamRoutingRuleApi.delete_team_routing_rule" end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling TeamRoutingRuleApi.delete_team_routing_rule" end if @api_client.config.client_side_validation && opts[:'team_identifier_type'] && !['id', 'name'].include?(opts[:'team_identifier_type']) fail ArgumentError, 'invalid value for "team_identifier_type", must be one of id, name' end # resource path local_var_path = '/v2/teams/{identifier}/routing-rules/{id}'.sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} query_params[:'teamIdentifierType'] = opts[:'team_identifier_type'] if !opts[:'team_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: TeamRoutingRuleApi#delete_team_routing_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get Team
Routing Rule Returns team routing rule with given id @param identifier Identifier of the team @param id Id of the team routing rule @param [Hash] opts the optional parameters @option opts [String] :team_identifier_type Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id' (default to id) @return [GetTeamRoutingRuleResponse]
# File lib/opsgenie_sdk/api/team_routing_rule_api.rb, line 227 def get_team_routing_rule(identifier, id, opts = {}) data, _status_code, _headers = get_team_routing_rule_with_http_info(identifier, id, opts) data end
Get Team
Routing Rule Returns team routing rule with given id @param identifier Identifier of the team @param id Id of the team routing rule @param [Hash] opts the optional parameters @option opts [String] :team_identifier_type Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id' @return [Array<(GetTeamRoutingRuleResponse
, Fixnum, Hash)>] GetTeamRoutingRuleResponse
data, response status code and response headers
# File lib/opsgenie_sdk/api/team_routing_rule_api.rb, line 239 def get_team_routing_rule_with_http_info(identifier, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TeamRoutingRuleApi.get_team_routing_rule ...' 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 TeamRoutingRuleApi.get_team_routing_rule" end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling TeamRoutingRuleApi.get_team_routing_rule" end if @api_client.config.client_side_validation && opts[:'team_identifier_type'] && !['id', 'name'].include?(opts[:'team_identifier_type']) fail ArgumentError, 'invalid value for "team_identifier_type", must be one of id, name' end # resource path local_var_path = '/v2/teams/{identifier}/routing-rules/{id}'.sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} query_params[:'teamIdentifierType'] = opts[:'team_identifier_type'] if !opts[:'team_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 => 'GetTeamRoutingRuleResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: TeamRoutingRuleApi#get_team_routing_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List Team
Routing Rules Returns list of team routing rules @param identifier Identifier of the team @param [Hash] opts the optional parameters @option opts [String] :team_identifier_type Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id' (default to id) @return [ListTeamRoutingRulesResponse]
# File lib/opsgenie_sdk/api/team_routing_rule_api.rb, line 290 def list_team_routing_rules(identifier, opts = {}) data, _status_code, _headers = list_team_routing_rules_with_http_info(identifier, opts) data end
List Team
Routing Rules Returns list of team routing rules @param identifier Identifier of the team @param [Hash] opts the optional parameters @option opts [String] :team_identifier_type Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id' @return [Array<(ListTeamRoutingRulesResponse
, Fixnum, Hash)>] ListTeamRoutingRulesResponse
data, response status code and response headers
# File lib/opsgenie_sdk/api/team_routing_rule_api.rb, line 301 def list_team_routing_rules_with_http_info(identifier, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TeamRoutingRuleApi.list_team_routing_rules ...' 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 TeamRoutingRuleApi.list_team_routing_rules" end if @api_client.config.client_side_validation && opts[:'team_identifier_type'] && !['id', 'name'].include?(opts[:'team_identifier_type']) fail ArgumentError, 'invalid value for "team_identifier_type", must be one of id, name' end # resource path local_var_path = '/v2/teams/{identifier}/routing-rules'.sub('{' + 'identifier' + '}', identifier.to_s) # query parameters query_params = {} query_params[:'teamIdentifierType'] = opts[:'team_identifier_type'] if !opts[:'team_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 => 'ListTeamRoutingRulesResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: TeamRoutingRuleApi#list_team_routing_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update Team
Routing Rule (Partial) Update routing rule of the team @param identifier Identifier of the team @param id Id of the team routing rule @param [Hash] opts the optional parameters @option opts [String] :team_identifier_type Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id' (default to id) @option opts [UpdateTeamRoutingRulePayload] :body Request payload of update Team
Routing Rule action @return [SuccessResponse]
# File lib/opsgenie_sdk/api/team_routing_rule_api.rb, line 350 def update_team_routing_rule(identifier, id, opts = {}) data, _status_code, _headers = update_team_routing_rule_with_http_info(identifier, id, opts) data end
Update Team
Routing Rule (Partial) Update routing rule of the team @param identifier Identifier of the team @param id Id of the team routing rule @param [Hash] opts the optional parameters @option opts [String] :team_identifier_type Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id' @option opts [UpdateTeamRoutingRulePayload] :body Request payload of update Team
Routing Rule action @return [Array<(SuccessResponse
, Fixnum, Hash)>] SuccessResponse
data, response status code and response headers
# File lib/opsgenie_sdk/api/team_routing_rule_api.rb, line 363 def update_team_routing_rule_with_http_info(identifier, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TeamRoutingRuleApi.update_team_routing_rule ...' 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 TeamRoutingRuleApi.update_team_routing_rule" end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling TeamRoutingRuleApi.update_team_routing_rule" end if @api_client.config.client_side_validation && opts[:'team_identifier_type'] && !['id', 'name'].include?(opts[:'team_identifier_type']) fail ArgumentError, 'invalid value for "team_identifier_type", must be one of id, name' end # resource path local_var_path = '/v2/teams/{identifier}/routing-rules/{id}'.sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} query_params[:'teamIdentifierType'] = opts[:'team_identifier_type'] if !opts[:'team_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 => 'SuccessResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: TeamRoutingRuleApi#update_team_routing_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end