class Tolq::Api::TranslationRequestApi

Handles all requests dealing with translation requests

Public Class Methods

new(client) click to toggle source

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.

# File lib/tolq-api/translation_request_api.rb, line 11
def initialize(client)
  @client = client
end

Public Instance Methods

create(request) click to toggle source

Creates and orders a new translation request

@param request [Hash] A hash consisting of a translation request, this maps 1:1 with the JSON request format. See our documentation for details @return [Tolq::Api::Response] A Tolq::Api::Response with an id, status and some metadata

# File lib/tolq-api/translation_request_api.rb, line 19
def create(request)
  @client.post('/translations/requests', request)
end
delete(id) click to toggle source

Deletes a translation request

@param id [Integer] An id referencing a translation request @return [true,false] A boolean indicating success

# File lib/tolq-api/translation_request_api.rb, line 58
def delete(id)
  @client.delete("/translations/requests/#{id}")
end
list() click to toggle source

Lists all your translation requests

@return [Tolq::Api::Response] A list of translation requests without translations

# File lib/tolq-api/translation_request_api.rb, line 42
def list
  @client.get('/translations/requests')
end
order(id) click to toggle source

Orders a translation request

@param id [Integer] An id referencing a translation request @return [Tolq::Api::Response] A Tolq::Api::Response with an id, status and some metadata

# File lib/tolq-api/translation_request_api.rb, line 50
def order(id)
  @client.post("/translations/requests/#{id}/order")
end
quote(request) click to toggle source

Creates but doesn't order a new translation request

@param request [Hash] A hash consisting of a translation request, this maps 1:1 with the JSON request format. See our documentation for details @return [Tolq::Api::Response] A Tolq::Api::Response with an id, status and some metadata

# File lib/tolq-api/translation_request_api.rb, line 35
def quote(request)
  @client.post('/translations/requests/quote', request)
end
show(id) click to toggle source

Retrieves a translation request

@param id [Integer] An id referencing a translation request @return [Tolq::Api::Response] A Tolq::Api::Response with an id, status and some metadata, if completed the translations are also included

# File lib/tolq-api/translation_request_api.rb, line 27
def show(id)
  @client.get("/translations/requests/#{id}")
end