Phrase\JobLocalesApi

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

Method	HTTP request	Description
jobLocaleComplete	POST /projects/{project_id}/jobs/{job_id}/locales/{id}/complete	Complete a job locale
jobLocaleCompleteReview	POST /projects/{project_id}/jobs/{job_id}/locales/{id}/complete_review	Review a job locale
jobLocaleDelete	DELETE /projects/{project_id}/jobs/{job_id}/locales/{id}	Remove a target locale from a job
jobLocaleReopen	POST /projects/{project_id}/jobs/{job_id}/locales/{id}/reopen	Reopen a job locale
jobLocaleShow	GET /projects/{project_id}/jobs/{job_id}/locales/{id}	Show single job target locale
jobLocaleUpdate	PATCH /projects/{project_id}/jobs/{job_id}/locales/{id}	Update a job target locale
jobLocalesCreate	POST /projects/{project_id}/jobs/{job_id}/locales	Add a target locale to a job
jobLocalesList	GET /projects/{project_id}/jobs/{job_id}/locales	List job target locales

jobLocaleComplete

\Phrase\Model\JobLocale jobLocaleComplete($project_id, $job_id, $id, $job_locale_complete_parameters, $x_phrase_app_otp)

Complete a job locale

Mark a job locale as completed.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$config = Phrase\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
$config = Phrase\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'token');

$apiInstance = new Phrase\Api\JobLocalesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_id = 'project_id_example'; // string | Project ID
$job_id = 'job_id_example'; // string | Job ID
$id = 'id_example'; // string | ID
$job_locale_complete_parameters = new \Phrase\Model\JobLocaleCompleteParameters(); // \Phrase\Model\JobLocaleCompleteParameters | 
$x_phrase_app_otp = 'x_phrase_app_otp_example'; // string | Two-Factor-Authentication token (optional)

try {
    $result = $apiInstance->jobLocaleComplete($project_id, $job_id, $id, $job_locale_complete_parameters, $x_phrase_app_otp);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobLocalesApi->jobLocaleComplete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string	Project ID
job_id	string	Job ID
id	string	ID
job_locale_complete_parameters	\Phrase\Model\JobLocaleCompleteParameters
x_phrase_app_otp	string	Two-Factor-Authentication token (optional)	[optional]

Return type

\Phrase\Model\JobLocale

Authorization

Basic, Token

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jobLocaleCompleteReview

\Phrase\Model\JobLocale jobLocaleCompleteReview($project_id, $job_id, $id, $job_locale_complete_review_parameters, $x_phrase_app_otp)

Review a job locale

Mark job locale as reviewed.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$config = Phrase\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
$config = Phrase\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'token');

$apiInstance = new Phrase\Api\JobLocalesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_id = 'project_id_example'; // string | Project ID
$job_id = 'job_id_example'; // string | Job ID
$id = 'id_example'; // string | ID
$job_locale_complete_review_parameters = new \Phrase\Model\JobLocaleCompleteReviewParameters(); // \Phrase\Model\JobLocaleCompleteReviewParameters | 
$x_phrase_app_otp = 'x_phrase_app_otp_example'; // string | Two-Factor-Authentication token (optional)

try {
    $result = $apiInstance->jobLocaleCompleteReview($project_id, $job_id, $id, $job_locale_complete_review_parameters, $x_phrase_app_otp);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobLocalesApi->jobLocaleCompleteReview: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string	Project ID
job_id	string	Job ID
id	string	ID
job_locale_complete_review_parameters	\Phrase\Model\JobLocaleCompleteReviewParameters
x_phrase_app_otp	string	Two-Factor-Authentication token (optional)	[optional]

Return type

\Phrase\Model\JobLocale

Authorization

Basic, Token

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jobLocaleDelete

jobLocaleDelete($project_id, $job_id, $id, $x_phrase_app_otp, $branch)

Remove a target locale from a job

Removes a target locale from a job.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$config = Phrase\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
$config = Phrase\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'token');

$apiInstance = new Phrase\Api\JobLocalesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_id = 'project_id_example'; // string | Project ID
$job_id = 'job_id_example'; // string | Job ID
$id = 'id_example'; // string | ID
$x_phrase_app_otp = 'x_phrase_app_otp_example'; // string | Two-Factor-Authentication token (optional)
$branch = my-feature-branch; // string | Branch to use

try {
    $apiInstance->jobLocaleDelete($project_id, $job_id, $id, $x_phrase_app_otp, $branch);
} catch (Exception $e) {
    echo 'Exception when calling JobLocalesApi->jobLocaleDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string	Project ID
job_id	string	Job ID
id	string	ID
x_phrase_app_otp	string	Two-Factor-Authentication token (optional)	[optional]
branch	string	Branch to use	[optional]

Return type

void (empty response body)

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jobLocaleReopen

\Phrase\Model\JobLocale jobLocaleReopen($project_id, $job_id, $id, $job_locale_reopen_parameters, $x_phrase_app_otp)

Reopen a job locale

Mark a job locale as uncompleted.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$config = Phrase\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
$config = Phrase\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'token');

$apiInstance = new Phrase\Api\JobLocalesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_id = 'project_id_example'; // string | Project ID
$job_id = 'job_id_example'; // string | Job ID
$id = 'id_example'; // string | ID
$job_locale_reopen_parameters = new \Phrase\Model\JobLocaleReopenParameters(); // \Phrase\Model\JobLocaleReopenParameters | 
$x_phrase_app_otp = 'x_phrase_app_otp_example'; // string | Two-Factor-Authentication token (optional)

try {
    $result = $apiInstance->jobLocaleReopen($project_id, $job_id, $id, $job_locale_reopen_parameters, $x_phrase_app_otp);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobLocalesApi->jobLocaleReopen: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string	Project ID
job_id	string	Job ID
id	string	ID
job_locale_reopen_parameters	\Phrase\Model\JobLocaleReopenParameters
x_phrase_app_otp	string	Two-Factor-Authentication token (optional)	[optional]

Return type

\Phrase\Model\JobLocale

Authorization

Basic, Token

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jobLocaleShow

\Phrase\Model\JobLocale jobLocaleShow($project_id, $job_id, $id, $x_phrase_app_otp, $branch)

Show single job target locale

Get a single target locale for a given job.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$config = Phrase\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
$config = Phrase\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'token');

$apiInstance = new Phrase\Api\JobLocalesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_id = 'project_id_example'; // string | Project ID
$job_id = 'job_id_example'; // string | Job ID
$id = 'id_example'; // string | ID
$x_phrase_app_otp = 'x_phrase_app_otp_example'; // string | Two-Factor-Authentication token (optional)
$branch = my-feature-branch; // string | Branch to use

try {
    $result = $apiInstance->jobLocaleShow($project_id, $job_id, $id, $x_phrase_app_otp, $branch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobLocalesApi->jobLocaleShow: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string	Project ID
job_id	string	Job ID
id	string	ID
x_phrase_app_otp	string	Two-Factor-Authentication token (optional)	[optional]
branch	string	Branch to use	[optional]

Return type

\Phrase\Model\JobLocale

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jobLocaleUpdate

\Phrase\Model\JobLocale jobLocaleUpdate($project_id, $job_id, $id, $job_locale_update_parameters, $x_phrase_app_otp)

Update a job target locale

Update an existing job target locale.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$config = Phrase\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
$config = Phrase\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'token');

$apiInstance = new Phrase\Api\JobLocalesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_id = 'project_id_example'; // string | Project ID
$job_id = 'job_id_example'; // string | Job ID
$id = 'id_example'; // string | ID
$job_locale_update_parameters = new \Phrase\Model\JobLocaleUpdateParameters(); // \Phrase\Model\JobLocaleUpdateParameters | 
$x_phrase_app_otp = 'x_phrase_app_otp_example'; // string | Two-Factor-Authentication token (optional)

try {
    $result = $apiInstance->jobLocaleUpdate($project_id, $job_id, $id, $job_locale_update_parameters, $x_phrase_app_otp);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobLocalesApi->jobLocaleUpdate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string	Project ID
job_id	string	Job ID
id	string	ID
job_locale_update_parameters	\Phrase\Model\JobLocaleUpdateParameters
x_phrase_app_otp	string	Two-Factor-Authentication token (optional)	[optional]

Return type

\Phrase\Model\JobLocale

Authorization

Basic, Token

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jobLocalesCreate

\Phrase\Model\JobLocale jobLocalesCreate($project_id, $job_id, $job_locales_create_parameters, $x_phrase_app_otp)

Add a target locale to a job

Adds a target locale to a job.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$config = Phrase\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
$config = Phrase\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'token');

$apiInstance = new Phrase\Api\JobLocalesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_id = 'project_id_example'; // string | Project ID
$job_id = 'job_id_example'; // string | Job ID
$job_locales_create_parameters = new \Phrase\Model\JobLocalesCreateParameters(); // \Phrase\Model\JobLocalesCreateParameters | 
$x_phrase_app_otp = 'x_phrase_app_otp_example'; // string | Two-Factor-Authentication token (optional)

try {
    $result = $apiInstance->jobLocalesCreate($project_id, $job_id, $job_locales_create_parameters, $x_phrase_app_otp);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobLocalesApi->jobLocalesCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string	Project ID
job_id	string	Job ID
job_locales_create_parameters	\Phrase\Model\JobLocalesCreateParameters
x_phrase_app_otp	string	Two-Factor-Authentication token (optional)	[optional]

Return type

\Phrase\Model\JobLocale

Authorization

Basic, Token

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jobLocalesList

\Phrase\Model\JobLocale[] jobLocalesList($project_id, $job_id, $x_phrase_app_otp, $page, $per_page, $branch)

List job target locales

List all target locales for a given job.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$config = Phrase\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
$config = Phrase\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'token');

$apiInstance = new Phrase\Api\JobLocalesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_id = 'project_id_example'; // string | Project ID
$job_id = 'job_id_example'; // string | Job ID
$x_phrase_app_otp = 'x_phrase_app_otp_example'; // string | Two-Factor-Authentication token (optional)
$page = 1; // int | Page number
$per_page = 25; // int | Limit on the number of objects to be returned, between 1 and 100. 25 by default
$branch = my-feature-branch; // string | Branch to use

try {
    $result = $apiInstance->jobLocalesList($project_id, $job_id, $x_phrase_app_otp, $page, $per_page, $branch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobLocalesApi->jobLocalesList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string	Project ID
job_id	string	Job ID
x_phrase_app_otp	string	Two-Factor-Authentication token (optional)	[optional]
page	int	Page number	[optional]
per_page	int	Limit on the number of objects to be returned, between 1 and 100. 25 by default	[optional]
branch	string	Branch to use	[optional]

Return type

\Phrase\Model\JobLocale[]

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

JobLocalesApi.md

Latest commit

History

JobLocalesApi.md

File metadata and controls

Phrase\JobLocalesApi

jobLocaleComplete

Example

Parameters

Return type

Authorization

HTTP request headers

jobLocaleCompleteReview

Example

Parameters

Return type

Authorization

HTTP request headers

jobLocaleDelete

Example

Parameters

Return type

Authorization

HTTP request headers

jobLocaleReopen

Example

Parameters

Return type

Authorization

HTTP request headers

jobLocaleShow

Example

Parameters

Return type

Authorization

HTTP request headers

jobLocaleUpdate

Example

Parameters

Return type

Authorization

HTTP request headers

jobLocalesCreate

Example

Parameters

Return type

Authorization

HTTP request headers

jobLocalesList

Example

Parameters

Return type

Authorization

HTTP request headers