Translation files

Fetch translation files

Doc

{:ok, files} = ElixirLokaliseApi.Files.all(project_id, page: 2, limit: 3)

file = hd files.items
file.filename

Download translation files

Doc

Exports project files as a .zip bundle and makes them available to download (the link is valid for 12 months).

data = %{
  format: "json",
  original_filenames: true
}

{:ok, resp} = ElixirLokaliseApi.Files.download(project_id, data)

resp.bundle_url

Download translation files (async)

Doc

Performs file export in background (asynchronously) and returns the process ID. Use the process ID to check for the process status.

params = %{
  format: "json",
  original_filenames: true
}

{:ok, process} = Files.download_async(project_id, params)

{:ok, process_info} = QueuedProcesses.find(project_id, process.process_id)

process_info.status # => "finished"
process_info.details[:download_url] # => "https://..."

Upload translation file

Doc

data = %{
  data: "ZnI6...",
  filename: "sample.yml",
  lang_iso: "fr"
}

{:ok, process} = ElixirLokaliseApi.Files.upload(project_id, data)
process.type
process.status # => "queued"

Your job is to periodically check the status of the queued process:

{:ok, process} = ElixirLokaliseApi.QueuedProcesses.find(project_id, process.process_id)

process.status # => "finished"

Delete translation file

Doc

Please note that this endpoint does not support “software localization” projects.

{:ok, %{} = resp} = Files.delete(project_id, file_id)

resp.file_deleted # => true
resp.project_id # => "123.abc"