Class: Tolq::Api::TranslationRequestApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tolq-api/translation_request_api.rb

Overview

Handles all requests dealing with translation requests

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ TranslationRequestApi

Creats a new Tolq::Api::ResponseApi.

Called indirectly via Client#translation_requests

You should check the ‘errors’ method on the translation request. Our API returns helpful validation errors if there are any.



11
12
13
 
# File 'lib/tolq-api/translation_request_api.rb', line 11

def initialize(client)
  @client = client
end

Instance Method Details

#create(request) ⇒ Tolq::Api::Response

Creates and orders a new translation request

Parameters:

  • request (Hash) —

    A hash consisting of a translation request, this maps 1:1 with the JSON request format. See our documentation for details

Returns:



19
20
21
 
# File 'lib/tolq-api/translation_request_api.rb', line 19

def create(request)
  @client.post('/translations/requests', request)
end

#delete(id) ⇒ true, false

Deletes a translation request

Parameters:

  • id (Integer) —

    An id referencing a translation request

Returns:

  • (true, false) —

    A boolean indicating success



58
59
60
 
# File 'lib/tolq-api/translation_request_api.rb', line 58

def delete(id)
  @client.delete("/translations/requests/#{id}")
end

#list ⇒ Tolq::Api::Response

Lists all your translation requests

Returns:



42
43
44
 
# File 'lib/tolq-api/translation_request_api.rb', line 42

def list
  @client.get('/translations/requests')
end

#order(id) ⇒ Tolq::Api::Response

Orders a translation request

Parameters:

  • id (Integer) —

    An id referencing a translation request

Returns:



50
51
52
 
# File 'lib/tolq-api/translation_request_api.rb', line 50

def order(id)
  @client.post("/translations/requests/#{id}/order")
end

#quote(request) ⇒ Tolq::Api::Response

Creates but doesn’t order a new translation request

Parameters:

  • request (Hash) —

    A hash consisting of a translation request, this maps 1:1 with the JSON request format. See our documentation for details

Returns:



35
36
37
 
# File 'lib/tolq-api/translation_request_api.rb', line 35

def quote(request)
  @client.post('/translations/requests/quote', request)
end

#show(id) ⇒ Tolq::Api::Response

Retrieves a translation request

Parameters:

  • id (Integer) —

    An id referencing a translation request

Returns:

  • (Tolq::Api::Response) —

    A Tolq::Api::Response with an id, status and some metadata, if completed the translations are also included



27
28
29
 
# File 'lib/tolq-api/translation_request_api.rb', line 27

def show(id)
  @client.get("/translations/requests/#{id}")
end