Phrase::JobsApi

All URIs are relative to https://api.phrase.com/v2

Method	HTTP request	Description
job_complete	POST /projects/{project_id}/jobs/{id}/complete	Complete a job
job_create	POST /projects/{project_id}/jobs	Create a job
job_delete	DELETE /projects/{project_id}/jobs/{id}	Delete a job
job_keys_create	POST /projects/{project_id}/jobs/{id}/keys	Add keys to job
job_keys_delete	DELETE /projects/{project_id}/jobs/{id}/keys	Remove keys from job
job_lock	POST /projects/{project_id}/jobs/{id}/lock	Lock a job
job_reopen	POST /projects/{project_id}/jobs/{id}/reopen	Reopen a job
job_show	GET /projects/{project_id}/jobs/{id}	Get a single job
job_start	POST /projects/{project_id}/jobs/{id}/start	Start a job
job_unlock	POST /projects/{project_id}/jobs/{id}/unlock	Unlock a job
job_update	PATCH /projects/{project_id}/jobs/{id}	Update a job
jobs_by_account	GET /accounts/{account_id}/jobs	List account jobs
jobs_list	GET /projects/{project_id}/jobs	List jobs

job_complete

JobDetails job_complete(project_id, id, job_complete_parameters, opts)

Complete a job

Mark a job as completed.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::JobsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
job_complete_parameters = Phrase::JobCompleteParameters.new # JobCompleteParameters | 
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}

begin
  #Complete a job
  result = api_instance.job_complete(project_id, id, job_complete_parameters, opts)
  pp result
rescue Phrase::ApiError => e
  puts "Exception when calling JobsApi->job_complete: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	String	Project ID
id	String	ID
job_complete_parameters	JobCompleteParameters
x_phrase_app_otp	String	Two-Factor-Authentication token (optional)	[optional]

Return type

Response<(JobDetails)>

Authorization

Basic, Token

HTTP request headers

Content-Type: application/json
Accept: application/json

job_create

JobDetails job_create(project_id, job_create_parameters, opts)

Create a job

Create a new job.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::JobsApi.new
project_id = 'project_id_example' # String | Project ID
job_create_parameters = Phrase::JobCreateParameters.new({name: 'de'}) # JobCreateParameters | 
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}

begin
  #Create a job
  result = api_instance.job_create(project_id, job_create_parameters, opts)
  pp result
rescue Phrase::ApiError => e
  puts "Exception when calling JobsApi->job_create: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	String	Project ID
job_create_parameters	JobCreateParameters
x_phrase_app_otp	String	Two-Factor-Authentication token (optional)	[optional]

Return type

Response<(JobDetails)>

Authorization

Basic, Token

HTTP request headers

Content-Type: application/json
Accept: application/json

job_delete

job_delete(project_id, id, opts)

Delete a job

Delete an existing job.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::JobsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
  branch: 'my-feature-branch' # String | specify the branch to use
}

begin
  #Delete a job
  api_instance.job_delete(project_id, id, opts)
rescue Phrase::ApiError => e
  puts "Exception when calling JobsApi->job_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	String	Project ID
id	String	ID
x_phrase_app_otp	String	Two-Factor-Authentication token (optional)	[optional]
branch	String	specify the branch to use	[optional]

Return type

Response<(nil (empty response body))>

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

job_keys_create

JobDetails job_keys_create(project_id, id, job_keys_create_parameters, opts)

Add keys to job

Add multiple keys to a existing job.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::JobsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
job_keys_create_parameters = Phrase::JobKeysCreateParameters.new # JobKeysCreateParameters | 
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}

begin
  #Add keys to job
  result = api_instance.job_keys_create(project_id, id, job_keys_create_parameters, opts)
  pp result
rescue Phrase::ApiError => e
  puts "Exception when calling JobsApi->job_keys_create: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	String	Project ID
id	String	ID
job_keys_create_parameters	JobKeysCreateParameters
x_phrase_app_otp	String	Two-Factor-Authentication token (optional)	[optional]

Return type

Response<(JobDetails)>

Authorization

Basic, Token

HTTP request headers

Content-Type: application/json
Accept: application/json

job_keys_delete

job_keys_delete(project_id, id, opts)

Remove keys from job

Remove multiple keys from existing job.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::JobsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
  branch: 'my-feature-branch', # String | specify the branch to use
  translation_key_ids: ['inner_example'] # Array<String> | ids of keys that should be removed from the job
}

begin
  #Remove keys from job
  api_instance.job_keys_delete(project_id, id, opts)
rescue Phrase::ApiError => e
  puts "Exception when calling JobsApi->job_keys_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	String	Project ID
id	String	ID
x_phrase_app_otp	String	Two-Factor-Authentication token (optional)	[optional]
branch	String	specify the branch to use	[optional]
translation_key_ids	Array<String>	ids of keys that should be removed from the job	[optional]

Return type

Response<(nil (empty response body))>

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

job_lock

job_lock(project_id, id, opts)

Lock a job

If you are the job owner, you may lock a job using this API request.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::JobsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
  branch: 'my-feature-branch' # String | specify the branch to use
}

begin
  #Lock a job
  api_instance.job_lock(project_id, id, opts)
rescue Phrase::ApiError => e
  puts "Exception when calling JobsApi->job_lock: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	String	Project ID
id	String	ID
x_phrase_app_otp	String	Two-Factor-Authentication token (optional)	[optional]
branch	String	specify the branch to use	[optional]

Return type

Response<(nil (empty response body))>

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

job_reopen

JobDetails job_reopen(project_id, id, job_reopen_parameters, opts)

Reopen a job

Mark a job as uncompleted.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::JobsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
job_reopen_parameters = Phrase::JobReopenParameters.new # JobReopenParameters | 
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}

begin
  #Reopen a job
  result = api_instance.job_reopen(project_id, id, job_reopen_parameters, opts)
  pp result
rescue Phrase::ApiError => e
  puts "Exception when calling JobsApi->job_reopen: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	String	Project ID
id	String	ID
job_reopen_parameters	JobReopenParameters
x_phrase_app_otp	String	Two-Factor-Authentication token (optional)	[optional]

Return type

Response<(JobDetails)>

Authorization

Basic, Token

HTTP request headers

Content-Type: application/json
Accept: application/json

job_show

JobDetails job_show(project_id, id, opts)

Get a single job

Get details on a single job for a given project.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::JobsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
  branch: 'my-feature-branch' # String | specify the branch to use
}

begin
  #Get a single job
  result = api_instance.job_show(project_id, id, opts)
  pp result
rescue Phrase::ApiError => e
  puts "Exception when calling JobsApi->job_show: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	String	Project ID
id	String	ID
x_phrase_app_otp	String	Two-Factor-Authentication token (optional)	[optional]
branch	String	specify the branch to use	[optional]

Return type

Response<(JobDetails)>

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

job_start

JobDetails job_start(project_id, id, job_start_parameters, opts)

Start a job

Starts an existing job in state draft.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::JobsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
job_start_parameters = Phrase::JobStartParameters.new # JobStartParameters | 
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}

begin
  #Start a job
  result = api_instance.job_start(project_id, id, job_start_parameters, opts)
  pp result
rescue Phrase::ApiError => e
  puts "Exception when calling JobsApi->job_start: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	String	Project ID
id	String	ID
job_start_parameters	JobStartParameters
x_phrase_app_otp	String	Two-Factor-Authentication token (optional)	[optional]

Return type

Response<(JobDetails)>

Authorization

Basic, Token

HTTP request headers

Content-Type: application/json
Accept: application/json

job_unlock

job_unlock(project_id, id, opts)

Unlock a job

If you are the job owner, you may unlock a locked job using this API request.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::JobsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
  branch: 'my-feature-branch' # String | specify the branch to use
}

begin
  #Unlock a job
  api_instance.job_unlock(project_id, id, opts)
rescue Phrase::ApiError => e
  puts "Exception when calling JobsApi->job_unlock: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	String	Project ID
id	String	ID
x_phrase_app_otp	String	Two-Factor-Authentication token (optional)	[optional]
branch	String	specify the branch to use	[optional]

Return type

Response<(nil (empty response body))>

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

job_update

JobDetails job_update(project_id, id, job_update_parameters, opts)

Update a job

Update an existing job.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::JobsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
job_update_parameters = Phrase::JobUpdateParameters.new # JobUpdateParameters | 
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}

begin
  #Update a job
  result = api_instance.job_update(project_id, id, job_update_parameters, opts)
  pp result
rescue Phrase::ApiError => e
  puts "Exception when calling JobsApi->job_update: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	String	Project ID
id	String	ID
job_update_parameters	JobUpdateParameters
x_phrase_app_otp	String	Two-Factor-Authentication token (optional)	[optional]

Return type

Response<(JobDetails)>

Authorization

Basic, Token

HTTP request headers

Content-Type: application/json
Accept: application/json

jobs_by_account

Array<Job> jobs_by_account(account_id, opts)

List account jobs

List all jobs for the given account.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::JobsApi.new
account_id = 'account_id_example' # String | Account ID
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
  page: 1, # Integer | Page number
  per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
  owned_by: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user owning job
  assigned_to: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user assigned to job
  state: 'completed' # String | filter by state of job Valid states are <code>draft</code>, <code>in_progress</code>, <code>completed</code>
}

begin
  #List account jobs
  result = api_instance.jobs_by_account(account_id, opts)
  pp result
rescue Phrase::ApiError => e
  puts "Exception when calling JobsApi->jobs_by_account: #{e}"
end

Parameters

Name	Type	Description	Notes
account_id	String	Account ID
x_phrase_app_otp	String	Two-Factor-Authentication token (optional)	[optional]
page	Integer	Page number	[optional]
per_page	Integer	Limit on the number of objects to be returned, between 1 and 100. 25 by default	[optional]
owned_by	String	filter by user owning job	[optional]
assigned_to	String	filter by user assigned to job	[optional]
state	String	filter by state of job Valid states are <code>draft</code>, <code>in_progress</code>, <code>completed</code>	[optional]

Return type

Response<(Array<Job>)>

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

jobs_list

Array<Job> jobs_list(project_id, opts)

List jobs

List all jobs for the given project.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::JobsApi.new
project_id = 'project_id_example' # String | Project ID
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
  page: 1, # Integer | Page number
  per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
  branch: 'my-feature-branch', # String | specify the branch to use
  owned_by: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user owning job
  assigned_to: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user assigned to job
  state: 'completed' # String | filter by state of job Valid states are <code>draft</code>, <code>in_progress</code>, <code>completed</code>
}

begin
  #List jobs
  result = api_instance.jobs_list(project_id, opts)
  pp result
rescue Phrase::ApiError => e
  puts "Exception when calling JobsApi->jobs_list: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	String	Project ID
x_phrase_app_otp	String	Two-Factor-Authentication token (optional)	[optional]
page	Integer	Page number	[optional]
per_page	Integer	Limit on the number of objects to be returned, between 1 and 100. 25 by default	[optional]
branch	String	specify the branch to use	[optional]
owned_by	String	filter by user owning job	[optional]
assigned_to	String	filter by user assigned to job	[optional]
state	String	filter by state of job Valid states are <code>draft</code>, <code>in_progress</code>, <code>completed</code>	[optional]

Return type

Response<(Array<Job>)>

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

Files

JobsApi.md

Latest commit

History

JobsApi.md

File metadata and controls

Phrase::JobsApi

job_complete

Example

Parameters

Return type

Authorization

HTTP request headers

job_create

Example

Parameters

Return type

Authorization

HTTP request headers

job_delete

Example

Parameters

Return type

Authorization

HTTP request headers

job_keys_create

Example

Parameters

Return type

Authorization

HTTP request headers

job_keys_delete

Example

Parameters

Return type

Authorization

HTTP request headers

job_lock

Example

Parameters

Return type

Authorization

HTTP request headers

job_reopen

Example

Parameters

Return type

Authorization

HTTP request headers

job_show

Example

Parameters

Return type

Authorization

HTTP request headers

job_start

Example

Parameters

Return type

Authorization

HTTP request headers

job_unlock

Example

Parameters

Return type

Authorization

HTTP request headers

job_update

Example

Parameters

Return type

Authorization

HTTP request headers

jobs_by_account

Example

Parameters

Return type

Authorization

HTTP request headers

jobs_list