LingoHub

v0.1.0

LingoHub v0.1.0 LingoHub View Source

Documentation for LingoHub.

Link to this section Summary

Types

account()
opts()
project()

Functions

fetch_project(account, project, opts)

Retrieve details for a given project of an account

fetch_resource(account, project, filename, opts)

Retrive the contents of a given resource

list_projects(opts)

Retrieve all the projects a user has access to

list_resources(account, project, opts)

Retrive a list of resources for a given project of an account

login(user_name, password)

Login using username and passwor to retrive the users api token

put_resource(account, project, file, opts)

Upload the contents of a file

Link to this section Types

Link to this type

account() View Source 
account() :: String.t()

Link to this type

opts() View Source 
opts() :: Keyword.t()

Link to this type

project() View Source 
project() :: String.t()

Link to this section Functions

Link to this function

fetch_project(account, project, opts) View Source 
fetch_project(account(), project(), opts()) ::
  {:ok, LingoHub.Project.t()} | {:error, term()}

Retrieve details for a given project of an account.

Link to this function

fetch_resource(account, project, filename, opts) View Source 
fetch_resource(account(), project(), filename :: binary(), opts()) ::
  {:ok, binary()} | {:error, term()}

Retrive the contents of a given resource.

Link to this function

list_projects(opts) View Source 
list_projects(opts()) :: {:ok, [LingoHub.Project.t()]} | {:error, term()}

Retrieve all the projects a user has access to.

Link to this function

list_resources(account, project, opts) View Source 
list_resources(account(), project(), opts()) ::
  {:ok, [LingoHub.Resource.t()]} | {:error, term()}

Retrive a list of resources for a given project of an account.

Link to this function

login(user_name, password) View Source 
login(String.t(), String.t()) :: {:ok, token :: String.t()} | {:error, term()}

Login using username and passwor to retrive the users api token.

Link to this function

put_resource(account, project, file, opts) View Source 
put_resource(account(), project(), file, opts()) :: :ok | {:error, term()}
when file: {:file, Path.t()} | {:binary, iodata()}

Upload the contents of a file