gengo v0.1.1 Gengo

This is an Elixir client for Gengo API, version 2. For more information, please see [Gengo’s developer documentation] (http://developers.gengo.com)

Summary

Functions

Return your Gengo API key as a string

Return your Gengo API secret as a string

Return details of your [Gengo account balance] (http://developers.gengo.com/v2/api_methods/account/#balance-get)

Delete [specific job by job ID] (http://developers.gengo.com/v2/api_methods/job/#job-delete)

Delete [specific job by ID] (http://developers.gengo.com/v2/api_methods/order/#order-delete)

Return the Gengo API endpoint URL as a string

Return [list of glossaries you uploaded with Gengo] (http://developers.gengo.com/v2/api_methods/glossary/#glossaries-get)

Return [specific glossary by ID] (http://developers.gengo.com/v2/api_methods/glossary/#glossary-get)

Return [specific job by ID] (http://developers.gengo.com/v2/api_methods/job/#job-get)

Return [feedback on specific job by job ID] (http://developers.gengo.com/v2/api_methods/job/#feedback-get)

Return [specific revision history on job by revision and job ID] (http://developers.gengo.com/v2/api_methods/job/#revision-get)

Retrieve [list of ordered job by IDs] (http://developers.gengo.com/v2/api_methods/jobs/#jobs-by-id-get)

Retrieve [list of ordered job by specific status] (http://developers.gengo.com/v2/api_methods/jobs/#jobs-get)

Return list of available [language pairs for ordering with Gengo] (http://developers.gengo.com/v2/api_methods/service/#language-pairs-get)

Return list of supported [languages in Gengo] (http://developers.gengo.com/v2/api_methods/service/#languages-get)

Return basic details of your [Gengo account] (http://developers.gengo.com/v2/api_methods/account/#me-get)

Return [specific order by ID] (http://developers.gengo.com/v2/api_methods/order/#order-get)

Return [comments on specific order by ID] (http://developers.gengo.com/v2/api_methods/order/#comments-get)

Post a [comment on specific job] (http://developers.gengo.com/v2/api_methods/job/#comment-post)

Post [jobs to be translated by Gengo] (http://developers.gengo.com/v2/api_methods/jobs/#jobs-post)

Post a [comment on specific order] (http://developers.gengo.com/v2/api_methods/order/#comment-post)

Return details of your [prefered Gengo translators] (http://developers.gengo.com/v2/api_methods/account/#preferred-translators-get)

Get a quote on [list of jobs for translation] (http://developers.gengo.com/v2/api_methods/service/#quote-post)

Return details on your [Gengo account statistics] (http://developers.gengo.com/v2/api_methods/account/#stats-get)

Update [specific job by job ID] (http://developers.gengo.com/v2/api_methods/job/#job-delete)

Update [jobs by job ID] (http://developers.gengo.com/v2/api_methods/jobs/#jobs-put)

Functions

api_key()

Return your Gengo API key as a string

Assumes that it is set in the GENGO_API_KEY env var

Examples

iex> Gengo.api_key
"HELLOGENGO"
api_secret()

Return your Gengo API secret as a string

Assumes that it is set in the GENGO_API_SECRET env var

Examples

iex> Gengo.api_secret
"TOPSECRET"
balance()

Return details of your [Gengo account balance] (http://developers.gengo.com/v2/api_methods/account/#balance-get)

delete_job(id)

Delete [specific job by job ID] (http://developers.gengo.com/v2/api_methods/job/#job-delete)

delete_order(id)

Delete [specific job by ID] (http://developers.gengo.com/v2/api_methods/order/#order-delete)

endpoint()

Return the Gengo API endpoint URL as a string

Examples

iex> Gengo.endpoint
"https://api.gengo.com/v2"
glossaries()

Return [list of glossaries you uploaded with Gengo] (http://developers.gengo.com/v2/api_methods/glossary/#glossaries-get)

glossary(id)

Return [specific glossary by ID] (http://developers.gengo.com/v2/api_methods/glossary/#glossary-get)

job(id)

Return [specific job by ID] (http://developers.gengo.com/v2/api_methods/job/#job-get)

job(id, atom)

Return [feedback on specific job by job ID] (http://developers.gengo.com/v2/api_methods/job/#feedback-get)

job(id, atom, revision_id)

Return [specific revision history on job by revision and job ID] (http://developers.gengo.com/v2/api_methods/job/#revision-get)

jobs_by_ids(ids)

Retrieve [list of ordered job by IDs] (http://developers.gengo.com/v2/api_methods/jobs/#jobs-by-id-get)

jobs_by_status(status \\ "reviewable", count \\ 10)

Retrieve [list of ordered job by specific status] (http://developers.gengo.com/v2/api_methods/jobs/#jobs-get)

language_pairs()

Return list of available [language pairs for ordering with Gengo] (http://developers.gengo.com/v2/api_methods/service/#language-pairs-get)

languages()

Return list of supported [languages in Gengo] (http://developers.gengo.com/v2/api_methods/service/#languages-get)

me()

Return basic details of your [Gengo account] (http://developers.gengo.com/v2/api_methods/account/#me-get)

order(id)

Return [specific order by ID] (http://developers.gengo.com/v2/api_methods/order/#order-get)

order(id, atom)

Return [comments on specific order by ID] (http://developers.gengo.com/v2/api_methods/order/#comments-get)

post_job_comment(id, comment)

Post a [comment on specific job] (http://developers.gengo.com/v2/api_methods/job/#comment-post)

post_jobs(jobs)

Post [jobs to be translated by Gengo] (http://developers.gengo.com/v2/api_methods/jobs/#jobs-post)

post_order_comment(id, comment)

Post a [comment on specific order] (http://developers.gengo.com/v2/api_methods/order/#comment-post)

preferred_translators()

Return details of your [prefered Gengo translators] (http://developers.gengo.com/v2/api_methods/account/#preferred-translators-get)

quote(jobs)

Get a quote on [list of jobs for translation] (http://developers.gengo.com/v2/api_methods/service/#quote-post)

quote_files(files)
stats()

Return details on your [Gengo account statistics] (http://developers.gengo.com/v2/api_methods/account/#stats-get)

update_job(id, action, payload)

Update [specific job by job ID] (http://developers.gengo.com/v2/api_methods/job/#job-delete)

update_jobs(action, payloads_or_ids)

Update [jobs by job ID] (http://developers.gengo.com/v2/api_methods/jobs/#jobs-put)

Please note, via the Gengo API documentation, what payload should be sent.