Class: OpsgenieSdk::TeamRoleApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TeamRoleApi

Returns a new instance of TeamRoleApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_team_role(identifier, body, opts = {}) ⇒ SuccessResponse

Create Team Role Creates a new team role

Parameters:

  • identifier —

    Identifier of the team

  • body —

    Request payload of created team role

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

    the optional parameters

Options Hash (opts):

  • :team_identifier_type (String) —

    Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id' (default to id)

Returns:



29
30
31
32
 
# File 'lib/opsgenie_sdk/api/team_role_api.rb', line 29

def create_team_role(identifier, body, opts = {})
  data, _status_code, _headers = create_team_role_with_http_info(identifier, body, opts)
  data
end

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

Create Team Role Creates a new team role

Parameters:

  • identifier —

    Identifier of the team

  • body —

    Request payload of created team role

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

    the optional parameters

Options Hash (opts):

  • :team_identifier_type (String) —

    Type of the identifier. Possible values are &#39;id&#39; and &#39;name&#39;. Default value is &#39;id&#39;

Returns:

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

    SuccessResponse data, response status code and response headers



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
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/opsgenie_sdk/api/team_role_api.rb', line 41

def create_team_role_with_http_info(identifier, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamRoleApi.create_team_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 TeamRoleApi.create_team_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 TeamRoleApi.create_team_role"
  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}/roles'.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: TeamRoleApi#create_team_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_team_role(identifier, team_role_identifier, opts = {}) ⇒ SuccessResponse

Delete Team Role Deletes a team role using team role ‘id’ or ‘name’

Parameters:

  • identifier —

    Identifier of the team

  • team_role_identifier —

    Identifier of team role which could be team role &#39;id&#39; or &#39;name&#39;

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

    the optional parameters

Options Hash (opts):

  • :team_identifier_type (String) —

    Type of the identifier. Possible values are &#39;id&#39; and &#39;name&#39;. Default value is &#39;id&#39; (default to id)

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



94
95
96
97
 
# File 'lib/opsgenie_sdk/api/team_role_api.rb', line 94

def delete_team_role(identifier, team_role_identifier, opts = {})
  data, _status_code, _headers = delete_team_role_with_http_info(identifier, team_role_identifier, opts)
  data
end

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

Delete Team Role Deletes a team role using team role &#39;id&#39; or &#39;name&#39;

Parameters:

  • identifier —

    Identifier of the team

  • team_role_identifier —

    Identifier of team role which could be team role &#39;id&#39; or &#39;name&#39;

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

    the optional parameters

Options Hash (opts):

  • :team_identifier_type (String) —

    Type of the identifier. Possible values are &#39;id&#39; and &#39;name&#39;. Default value is &#39;id&#39;

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



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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/opsgenie_sdk/api/team_role_api.rb', line 107

def delete_team_role_with_http_info(identifier, team_role_identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamRoleApi.delete_team_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 TeamRoleApi.delete_team_role"
  end
  # verify the required parameter 'team_role_identifier' is set
  if @api_client.config.client_side_validation && team_role_identifier.nil?
    fail ArgumentError, "Missing the required parameter 'team_role_identifier' when calling TeamRoleApi.delete_team_role"
  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
  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/teams/{identifier}/roles/{teamRoleIdentifier}'.sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'teamRoleIdentifier' + '}', team_role_identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'teamIdentifierType'] = opts[:'team_identifier_type'] if !opts[:'team_identifier_type'].nil?
  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: TeamRoleApi#delete_team_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_team_role(identifier, team_role_identifier, opts = {}) ⇒ GetTeamRoleResponse

Get Team Role Returns team role with given ‘id’ or ‘name’

Parameters:

  • identifier —

    Identifier of the team

  • team_role_identifier —

    Identifier of team role which could be team role &#39;id&#39; or &#39;name&#39;

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

    the optional parameters

Options Hash (opts):

  • :team_identifier_type (String) —

    Type of the identifier. Possible values are &#39;id&#39; and &#39;name&#39;. Default value is &#39;id&#39; (default to id)

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



164
165
166
167
 
# File 'lib/opsgenie_sdk/api/team_role_api.rb', line 164

def get_team_role(identifier, team_role_identifier, opts = {})
  data, _status_code, _headers = get_team_role_with_http_info(identifier, team_role_identifier, opts)
  data
end

#get_team_role_with_http_info(identifier, team_role_identifier, opts = {}) ⇒ Array<(GetTeamRoleResponse, Fixnum, Hash)>

Get Team Role Returns team role with given &#39;id&#39; or &#39;name&#39;

Parameters:

  • identifier —

    Identifier of the team

  • team_role_identifier —

    Identifier of team role which could be team role &#39;id&#39; or &#39;name&#39;

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

    the optional parameters

Options Hash (opts):

  • :team_identifier_type (String) —

    Type of the identifier. Possible values are &#39;id&#39; and &#39;name&#39;. Default value is &#39;id&#39;

  • :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<(GetTeamRoleResponse, Fixnum, Hash)>) —

    GetTeamRoleResponse data, response status code and response headers



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
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
 
# File 'lib/opsgenie_sdk/api/team_role_api.rb', line 177

def get_team_role_with_http_info(identifier, team_role_identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamRoleApi.get_team_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 TeamRoleApi.get_team_role"
  end
  # verify the required parameter 'team_role_identifier' is set
  if @api_client.config.client_side_validation && team_role_identifier.nil?
    fail ArgumentError, "Missing the required parameter 'team_role_identifier' when calling TeamRoleApi.get_team_role"
  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
  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/teams/{identifier}/roles/{teamRoleIdentifier}'.sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'teamRoleIdentifier' + '}', team_role_identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'teamIdentifierType'] = opts[:'team_identifier_type'] if !opts[:'team_identifier_type'].nil?
  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 => 'GetTeamRoleResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamRoleApi#get_team_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_team_roles(identifier, opts = {}) ⇒ ListTeamRoleResponse

List Team Roles Returns list of team roles

Parameters:

  • identifier —

    Identifier of the team

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

    the optional parameters

Options Hash (opts):

  • :team_identifier_type (String) —

    Type of the identifier. Possible values are &#39;id&#39; and &#39;name&#39;. Default value is &#39;id&#39; (default to id)

Returns:



232
233
234
235
 
# File 'lib/opsgenie_sdk/api/team_role_api.rb', line 232

def list_team_roles(identifier, opts = {})
  data, _status_code, _headers = list_team_roles_with_http_info(identifier, opts)
  data
end

#list_team_roles_with_http_info(identifier, opts = {}) ⇒ Array<(ListTeamRoleResponse, Fixnum, Hash)>

List Team Roles Returns list of team roles

Parameters:

  • identifier —

    Identifier of the team

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

    the optional parameters

Options Hash (opts):

  • :team_identifier_type (String) —

    Type of the identifier. Possible values are &#39;id&#39; and &#39;name&#39;. Default value is &#39;id&#39;

Returns:

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

    ListTeamRoleResponse data, response status code and response headers



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
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
 
# File 'lib/opsgenie_sdk/api/team_role_api.rb', line 243

def list_team_roles_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamRoleApi.list_team_roles ...'
  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 TeamRoleApi.list_team_roles"
  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}/roles'.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 => 'ListTeamRoleResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamRoleApi#list_team_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_team_role(identifier, team_role_identifier, opts = {}) ⇒ SuccessResponse

Update Team Role (Partial) Updates the team role using team role ‘id’ or ‘name’

Parameters:

  • identifier —

    Identifier of the team

  • team_role_identifier —

    Identifier of team role which could be team role &#39;id&#39; or &#39;name&#39;

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

    the optional parameters

Options Hash (opts):

  • :team_identifier_type (String) —

    Type of the identifier. Possible values are &#39;id&#39; and &#39;name&#39;. Default value is &#39;id&#39; (default to id)

  • :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 (UpdateTeamRolePayload) —

    Request payload of update team role

Returns:



293
294
295
296
 
# File 'lib/opsgenie_sdk/api/team_role_api.rb', line 293

def update_team_role(identifier, team_role_identifier, opts = {})
  data, _status_code, _headers = update_team_role_with_http_info(identifier, team_role_identifier, opts)
  data
end

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

Update Team Role (Partial) Updates the team role using team role &#39;id&#39; or &#39;name&#39;

Parameters:

  • identifier —

    Identifier of the team

  • team_role_identifier —

    Identifier of team role which could be team role &#39;id&#39; or &#39;name&#39;

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

    the optional parameters

Options Hash (opts):

  • :team_identifier_type (String) —

    Type of the identifier. Possible values are &#39;id&#39; and &#39;name&#39;. Default value is &#39;id&#39;

  • :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 (UpdateTeamRolePayload) —

    Request payload of update team role

Returns:

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

    SuccessResponse data, response status code and response headers



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/opsgenie_sdk/api/team_role_api.rb', line 307

def update_team_role_with_http_info(identifier, team_role_identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamRoleApi.update_team_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 TeamRoleApi.update_team_role"
  end
  # verify the required parameter 'team_role_identifier' is set
  if @api_client.config.client_side_validation && team_role_identifier.nil?
    fail ArgumentError, "Missing the required parameter 'team_role_identifier' when calling TeamRoleApi.update_team_role"
  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
  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/teams/{identifier}/roles/{teamRoleIdentifier}'.sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'teamRoleIdentifier' + '}', team_role_identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'teamIdentifierType'] = opts[:'team_identifier_type'] if !opts[:'team_identifier_type'].nil?
  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 => 'SuccessResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamRoleApi#update_team_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end