OpsGenie REST API v0.1.0 OpsGenieRESTAPI.Api.Integration

API calls for all endpoints tagged Integration.

Link to this section Summary

Functions

Authenticate Integration Authenticates integration with given type

Create Integration Creates a new integration

Delete Integration Delete integration with given id

Disable Integration Disable integration with given ID

Enable Integration Enable integration with given ID

Get Integration Returns integration with given id

List Integrations Returns list of integrations with given parameters

Update Integration Update integration with given id

Link to this section Functions

Link to this function authenticate_integration(connection, body, opts \\ [])

Authenticate Integration Authenticates integration with given type

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • body (AuthenticateIntegrationPayload): Request payload to authenticate integration
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %OpsGenieRESTAPI.Model.SuccessResponse{}} on success {:error, info} on failure

Link to this function create_integration(connection, body, opts \\ [])

Create Integration Creates a new integration

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • body (Integration): Request payload of created integration
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %OpsGenieRESTAPI.Model.CreateIntegrationResponse{}} on success {:error, info} on failure

Link to this function delete_integration(connection, id, opts \\ [])
delete_integration(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, OpsGenieRESTAPI.Model.SuccessResponse.t()} | {:error, Tesla.Env.t()}

Delete Integration Delete integration with given id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • id (String.t): Integration Id
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %OpsGenieRESTAPI.Model.SuccessResponse{}} on success {:error, info} on failure

Link to this function disable_integration(connection, id, opts \\ [])

Disable Integration Disable integration with given ID

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • id (String.t): Integration Id
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %OpsGenieRESTAPI.Model.DisableIntegrationResponse{}} on success {:error, info} on failure

Link to this function enable_integration(connection, id, opts \\ [])

Enable Integration Enable integration with given ID

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • id (String.t): Integration Id
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %OpsGenieRESTAPI.Model.EnableIntegrationResponse{}} on success {:error, info} on failure

Link to this function get_integration(connection, id, opts \\ [])

Get Integration Returns integration with given id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • id (String.t): Integration Id
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %OpsGenieRESTAPI.Model.GetIntegrationResponse{}} on success {:error, info} on failure

Link to this function list_integrations(connection, opts \\ [])
list_integrations(Tesla.Env.client(), keyword()) ::
  {:ok, OpsGenieRESTAPI.Model.ListIntegrationsResponse.t()}
  | {:error, Tesla.Env.t()}

List Integrations Returns list of integrations with given parameters

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :type (String.t): Type of the integration (For instance, "API" for API Integration). If type parameter is given, the result will be filtered by type
    • :team_id (String.t): The ID of the team. If the team ID parameter is given, the result will be filtered by teamId
    • :team_name (String.t): The name of the team. If the team name parameter is given, the result will be filtered by teamName

Returns

{:ok, %OpsGenieRESTAPI.Model.ListIntegrationsResponse{}} on success {:error, info} on failure

Link to this function update_integration(connection, id, body, opts \\ [])

Update Integration Update integration with given id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • id (String.t): Integration Id
  • body (Integration): Request payload of update integration action
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %OpsGenieRESTAPI.Model.UpdateIntegrationResponse{}} on success {:error, info} on failure