ExDoppler.Integrations (ExDoppler v1.0.0)
View SourceModule for interacting with ExDoppler.Integration
๐ Resources
- ๐ Doppler docs
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Summary
Functions
Creates a new ExDoppler.Integration
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
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
{:err, err}
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as create_integration/3
but won't wrap a successful response in {:ok, response}
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
{:err, err}
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as delete_integration/1
but won't wrap a successful response in {:ok, response}
Retrieves a ExDoppler.Integration
๐ท๏ธ Params
- integration_slug: The relevant integration (e.g
"gh-integration"
)
โคต๏ธ Returns
โ On Success
{:ok, %ExDoppler.Integration{...}}
โ On Failure
{:err, err}
๐ป Examples
iex> alias ExDoppler.Integrations
iex> [integration | _] = Integrations.list_integrations!()
iex> _integration = Integrations.get_integration(integration.slug)
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as get_integration/1
but won't wrap a successful response in {:ok, response}
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
{:err, err}
๐ป Examples
iex> alias ExDoppler.Integrations
iex> [integration | _] = Integrations.list_integrations!()
iex> _integration = Integrations.get_integration_options(integration.slug)
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as get_integration_options/1
but won't wrap a successful response in {:ok, response}
Lists ExDoppler.Integration
โคต๏ธ Returns
โ On Success
{:ok, [%ExDoppler.Integration{...}]}
โ On Failure
{:err, err}
๐ป Examples
iex> alias ExDoppler.Integrations
iex> {:ok, _integrations} = Integrations.list_integrations()
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as list_integrations/0
but won't wrap a successful response in {:ok, response}
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
{:err, err}
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as update_integration/3
but won't wrap a successful response in {:ok, response}