Projects. Needs :team_token. Report forwarding is in
Lettermint.Projects.ReportForwarding, routes in Lettermint.Routes.
Every function takes the options timeout: (milliseconds) last.
Summary
Functions
Creates a project. The response holds its sending token once (api_token).
Deletes a project.
Streams every project, following next_cursor. Raises the error of a failed page request.
Lists projects, one page at a time. query: Lettermint.Types.ListProjectsQuery.t/0.
Retrieves a project.
Rotates the project's legacy sending token. The API marks this endpoint as legacy.
Updates a project.
Types
@type result(value) :: {:ok, value} | {:error, Lettermint.Error.t()}
Functions
@spec create( Lettermint.Client.t(), Lettermint.Types.StoreProjectData.t() | map(), keyword() ) :: result(Lettermint.Types.ProjectCreatedData.t())
Creates a project. The response holds its sending token once (api_token).
@spec delete(Lettermint.Client.t(), String.t(), keyword()) :: result(Lettermint.Types.MessageResponse.t())
Deletes a project.
@spec iterate( Lettermint.Client.t(), Lettermint.Types.ListProjectsQuery.t(), keyword() ) :: Enumerable.t(Lettermint.Types.ProjectListData.t())
Streams every project, following next_cursor. Raises the error of a failed page request.
@spec list(Lettermint.Client.t(), Lettermint.Types.ListProjectsQuery.t(), keyword()) :: result(Lettermint.Types.ListProjectsResponse.t())
Lists projects, one page at a time. query: Lettermint.Types.ListProjectsQuery.t/0.
@spec retrieve( Lettermint.Client.t(), String.t(), Lettermint.Types.GetProjectQuery.t(), keyword() ) :: result(Lettermint.Types.ProjectData.t())
Retrieves a project.
@spec rotate_token(Lettermint.Client.t(), String.t(), keyword()) :: result(Lettermint.Types.RotateProjectTokenResponse.t())
Rotates the project's legacy sending token. The API marks this endpoint as legacy.
@spec update( Lettermint.Client.t(), String.t(), Lettermint.Types.UpdateProjectData.t() | map(), keyword() ) :: result(Lettermint.Types.ProjectMutationResponse.t())
Updates a project.