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
authenticate_integration( Tesla.Env.client(), OpsGenieRESTAPI.Model.AuthenticateIntegrationPayload.t(), keyword() ) :: {:ok, OpsGenieRESTAPI.Model.SuccessResponse.t()} | {:error, Tesla.Env.t()}
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
create_integration( Tesla.Env.client(), OpsGenieRESTAPI.Model.Integration.t(), keyword() ) :: {:ok, OpsGenieRESTAPI.Model.CreateIntegrationResponse.t()} | {:error, Tesla.Env.t()}
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
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
disable_integration(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpsGenieRESTAPI.Model.DisableIntegrationResponse.t()} | {:error, Tesla.Env.t()}
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
enable_integration(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpsGenieRESTAPI.Model.EnableIntegrationResponse.t()} | {:error, Tesla.Env.t()}
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
get_integration(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpsGenieRESTAPI.Model.GetIntegrationResponse.t()} | {:error, Tesla.Env.t()}
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
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
update_integration( Tesla.Env.client(), String.t(), OpsGenieRESTAPI.Model.Integration.t(), keyword() ) :: {:ok, OpsGenieRESTAPI.Model.UpdateIntegrationResponse.t()} | {:error, Tesla.Env.t()}
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