ExDoppler.Projects (ExDoppler v1.0.0)
View SourceModule for interacting with ExDoppler.Project
๐ Resources
- ๐ Doppler docs
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Summary
Functions
Same as create_project/1
but won't wrap a successful response in {:ok, response}
Deletes a ExDoppler.Project
Same as delete_project/1
but won't wrap a successful response in {:ok, response}
Retrieves a ExDoppler.Project
, given an identifier
Same as get_project/1
but won't wrap a successful response in {:ok, response}
Lists project permissions across all roles
Same as list_project_permissions/0
but won't wrap a successful response in {:ok, response}
Lists ExDoppler.Project
using pagination
Same as list_projects/1
but won't wrap a successful response in {:ok, response}
Same as update_project/1
but won't wrap a successful response in {:ok, response}
Functions
Creates a new ExDoppler.Project
๐ท๏ธ Params
- project_name: New Project Name (e.g
"example-project"
) - description: Optional description (e.g
"my awesome project"
)
โคต๏ธ Returns
โ On Success
{:ok, %ExDoppler.Project{...}}
โ On Failure
{:err, err}
๐ป Examples
iex> alias ExDoppler.Projects
iex> alias ExDoppler.Project
iex> _ = Projects.delete_project!(%Project{name: "example-doc-project"})
iex> {:ok, project} = Projects.create_project("example-doc-project")
iex> :ok = Projects.delete_project!(project)
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as create_project/1
but won't wrap a successful response in {:ok, response}
Deletes a ExDoppler.Project
๐ท๏ธ Params
- project: The relevant project (e.g
%Project{name: "example-project" ...}
)
โคต๏ธ Returns
โ On Success
{:ok, {:success, true}
โ On Failure
{:err, err}
๐ป Examples
iex> alias ExDoppler.Projects
iex> alias ExDoppler.Project
iex> _ = Projects.delete_project!(%Project{name: "example-doc-project"})
iex> project = Projects.create_project!("example-doc-project")
iex> {:ok, {:success, true}} = Projects.delete_project(project)
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as delete_project/1
but won't wrap a successful response in {:ok, response}
Retrieves a ExDoppler.Project
, given an identifier
๐ท๏ธ Params
identifier
- identifier for project (e.g"example-project"
)
โคต๏ธ Returns
โ On Success
{:ok, %ExDoppler.Project{...}}
โ On Failure
{:err, err}
๐ป Examples
iex> alias ExDoppler.Projects
iex> {:ok, _project} = Projects.get_project("example-project")
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as get_project/1
but won't wrap a successful response in {:ok, response}
Lists project permissions across all roles
โคต๏ธ Returns
โ On Success
{:ok, ["perm1" ...]}
โ On Failure
{:err, err}
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as list_project_permissions/0
but won't wrap a successful response in {:ok, response}
Lists ExDoppler.Project
using pagination
๐ท๏ธ Params
- opts: Optional modifications to the list call
- page - which page to list (starts at 1) (e.g
page: 2
). Default:1
- per_page - the number of
ExDoppler.Project
to return for this page (e.gper_page: 50
). Default:20
- page - which page to list (starts at 1) (e.g
โคต๏ธ Returns
โ On Success
{:ok, [%ExDoppler.Project{...} ...]}
โ On Failure
{:err, err}
๐ป Examples
iex> alias ExDoppler.Projects
iex> {:ok, _projects} = Projects.list_projects(page: 1, per_page: 20)
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as list_projects/1
but won't wrap a successful response in {:ok, response}
Updates an ExDoppler.Project
๐ท๏ธ Params
- project: The relevant project (e.g
%Project{name: "example-project" ...}
) - opts: Optional modifications
- name - New name for this project
- description - New description for this project
โคต๏ธ Returns
โ On Success
{:ok, %ExDoppler.Project{...}}
โ On Failure
{:err, err}
๐ป Examples
iex> alias ExDoppler.Projects
iex> alias ExDoppler.Project
iex> _ = Projects.delete_project!(%Project{name: "example-doc-project"})
iex> project = Projects.create_project!("example-doc-project")
iex> {:ok, project} = Projects.update_project(project, description: "new description")
iex> :ok = Projects.delete_project!(project)
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as update_project/1
but won't wrap a successful response in {:ok, response}