ExDoppler.Integrations (ExDoppler v1.0.1)

View Source

Module for interacting with ExDoppler.Integration

๐Ÿ“– Resources

Summary

Functions

Same as create_integration/3 but won't wrap a successful response in {:ok, response}

Same as delete_integration/1 but won't wrap a successful response in {:ok, response}

Same as get_integration/1 but won't wrap a successful response in {:ok, response}

Returns the data payload for the integration

Same as get_integration_options/1 but won't wrap a successful response in {:ok, response}

Same as list_integrations/0 but won't wrap a successful response in {:ok, response}

Same as update_integration/3 but won't wrap a successful response in {:ok, response}

Functions

create_integration(type, name, data)

Creates a new ExDoppler.Integration

Read the API docs!

The data parameter is tailored toward each kind of type.

๐Ÿท๏ธ Params

  • type: Integration Type (e.g "aws_secrets_manager")
  • name: Integration Name (e.g "aws-secrets-integration")
  • data: A map containing fields that are specific to each integration (e.g %{"aws_assume_role_arn" : "arn..."})

โคต๏ธ Returns

โœ… On Success

  {:ok, %ExDoppler.Integration{...}}

โŒ On Failure

  {:error, err}

๐Ÿ“– Resources

create_integration!(type, name, data)

Same as create_integration/3 but won't wrap a successful response in {:ok, response}

delete_integration(integration)

Deletes a ExDoppler.Integration

๐Ÿท๏ธ Params

  • integration: The relevant integration (e.g %Integration{slug: "e32d0dcd-c094-4606-aefa-c4127e2a1282"... })

โคต๏ธ Returns

โœ… On Success

  {:ok, {:success, true}}

โŒ On Failure

  {:error, err}

๐Ÿ“– Resources

delete_integration!(integration)

Same as delete_integration/1 but won't wrap a successful response in {:ok, response}

get_integration(integration_slug)

Retrieves a ExDoppler.Integration

๐Ÿท๏ธ Params

  • integration_slug: The relevant integration (e.g "gh-integration")

โคต๏ธ Returns

โœ… On Success

  {:ok, %ExDoppler.Integration{...}}

โŒ On Failure

  {:error, err}

๐Ÿ’ป Examples

iex> alias ExDoppler.Integrations
iex> [integration | _] = Integrations.list_integrations!()
iex> _integration = Integrations.get_integration(integration.slug)

๐Ÿ“– Resources

get_integration!(integration_slug)

Same as get_integration/1 but won't wrap a successful response in {:ok, response}

get_integration_options(integration_slug)

Returns the data payload for the integration

Read the API docs!

These options relate to the data payload inside each integration Please use with care

๐Ÿท๏ธ Params

  • integration_slug: Unique identifier for the integration (e.g "00000000-0000-0000-0000-000000000000")

โคต๏ธ Returns

โœ… On Success

  {:ok, options}

โŒ On Failure

  {:error, err}

๐Ÿ’ป Examples

iex> alias ExDoppler.Integrations
iex> [integration | _] = Integrations.list_integrations!()
iex> _integration = Integrations.get_integration_options(integration.slug)

๐Ÿ“– Resources

get_integration_options!(integration_slug)

Same as get_integration_options/1 but won't wrap a successful response in {:ok, response}

list_integrations()

Lists ExDoppler.Integration

โคต๏ธ Returns

โœ… On Success

  {:ok, [%ExDoppler.Integration{...}]}

โŒ On Failure

  {:error, err}

๐Ÿ’ป Examples

iex> alias ExDoppler.Integrations
iex> {:ok, _integrations} = Integrations.list_integrations()

๐Ÿ“– Resources

list_integrations!()

Same as list_integrations/0 but won't wrap a successful response in {:ok, response}

update_integration(integration, new_name, new_data)

Updates an ExDoppler.Integration

Read the API docs!

The data parameter is tailored toward each kind of type.

๐Ÿท๏ธ Params

  • Integration: Integration to update (e.g %Integration{slug: "e32d0dcd-c094-4606-aefa-c4127e2a1282"... })
  • data: A map containing fields that are specific to each integration (e.g %{"aws_assume_role_arn" : "arn..."})

โคต๏ธ Returns

โœ… On Success

  {:ok, %ExDoppler.Integration{...}}

โŒ On Failure

  {:error, err}

๐Ÿ“– Resources

update_integration!(integration, new_name, new_data)

Same as update_integration/3 but won't wrap a successful response in {:ok, response}