docs/TranslationsApi.md in phrase-1.0.1 vs docs/TranslationsApi.md in phrase-1.0.2
- old
+ new
@@ -24,11 +24,11 @@
## translation_create
-> translation_create(project_id, translation_create_parameters, opts)
+> TranslationDetails translation_create(project_id, translation_create_parameters, opts)
Create a translation
Create a translation.
@@ -43,12 +43,11 @@
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token
config.api_key['Authorization'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['Authorization'] = 'Bearer'
+ config.api_key_prefix['Authorization'] = 'token'
end
api_instance = Phrase::TranslationsApi.new
project_id = 'project_id_example' # String | Project ID
translation_create_parameters = Phrase::TranslationCreateParameters.new # TranslationCreateParameters |
@@ -56,11 +55,12 @@
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}
begin
#Create a translation
- api_instance.translation_create(project_id, translation_create_parameters, opts)
+ result = api_instance.translation_create(project_id, translation_create_parameters, opts)
+ pp result
rescue Phrase::ApiError => e
puts "Exception when calling TranslationsApi->translation_create: #{e}"
end
```
@@ -73,20 +73,20 @@
**translation_create_parameters** | [**TranslationCreateParameters**](TranslationCreateParameters.md)| |
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
### Return type
-Response<(nil (empty response body))>
+Response<([**TranslationDetails**](TranslationDetails.md))>
### Authorization
[Basic](../README.md#Basic), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json
-- **Accept**: Not defined
+- **Accept**: application/json
## translation_exclude
> TranslationDetails translation_exclude(project_id, id, translation_exclude_parameters, opts)
@@ -106,12 +106,11 @@
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token
config.api_key['Authorization'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['Authorization'] = 'Bearer'
+ config.api_key_prefix['Authorization'] = 'token'
end
api_instance = Phrase::TranslationsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
@@ -172,12 +171,11 @@
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token
config.api_key['Authorization'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['Authorization'] = 'Bearer'
+ config.api_key_prefix['Authorization'] = 'token'
end
api_instance = Phrase::TranslationsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
@@ -238,12 +236,11 @@
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token
config.api_key['Authorization'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['Authorization'] = 'Bearer'
+ config.api_key_prefix['Authorization'] = 'token'
end
api_instance = Phrase::TranslationsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
@@ -304,12 +301,11 @@
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token
config.api_key['Authorization'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['Authorization'] = 'Bearer'
+ config.api_key_prefix['Authorization'] = 'token'
end
api_instance = Phrase::TranslationsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
@@ -370,12 +366,11 @@
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token
config.api_key['Authorization'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['Authorization'] = 'Bearer'
+ config.api_key_prefix['Authorization'] = 'token'
end
api_instance = Phrase::TranslationsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
@@ -436,12 +431,11 @@
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token
config.api_key['Authorization'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['Authorization'] = 'Bearer'
+ config.api_key_prefix['Authorization'] = 'token'
end
api_instance = Phrase::TranslationsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
@@ -502,12 +496,11 @@
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token
config.api_key['Authorization'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['Authorization'] = 'Bearer'
+ config.api_key_prefix['Authorization'] = 'token'
end
api_instance = Phrase::TranslationsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
@@ -568,12 +561,11 @@
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token
config.api_key['Authorization'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['Authorization'] = 'Bearer'
+ config.api_key_prefix['Authorization'] = 'token'
end
api_instance = Phrase::TranslationsApi.new
project_id = 'project_id_example' # String | Project ID
key_id = 'key_id_example' # String | Translation Key ID
@@ -582,11 +574,11 @@
page: 1, # Integer | Page number
per_page: 10, # Integer | allows you to specify a page size up to 100 items, 10 by default
branch: 'my-feature-branch', # String | specify the branch to use
sort: 'updated_at', # String | Sort criteria. Can be one of: key_name, created_at, updated_at.
order: 'desc', # String | Order direction. Can be one of: asc, desc.
- q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | q_description_placeholder
+ q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | Specify a query to find translations by content (including wildcards).<br><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
}
begin
#List translations by key
result = api_instance.translations_by_key(project_id, key_id, opts)
@@ -607,11 +599,11 @@
**page** | **Integer**| Page number | [optional]
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 10 by default | [optional]
**branch** | **String**| specify the branch to use | [optional]
**sort** | **String**| Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
- **q** | **String**| q_description_placeholder | [optional]
+ **q** | **String**| Specify a query to find translations by content (including wildcards).<br><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. | [optional]
### Return type
Response<([**Array<Translation>**](Translation.md))>
@@ -644,12 +636,11 @@
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token
config.api_key['Authorization'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['Authorization'] = 'Bearer'
+ config.api_key_prefix['Authorization'] = 'token'
end
api_instance = Phrase::TranslationsApi.new
project_id = 'project_id_example' # String | Project ID
locale_id = 'locale_id_example' # String | Locale ID
@@ -658,11 +649,11 @@
page: 1, # Integer | Page number
per_page: 10, # Integer | allows you to specify a page size up to 100 items, 10 by default
branch: 'my-feature-branch', # String | specify the branch to use
sort: 'updated_at', # String | Sort criteria. Can be one of: key_name, created_at, updated_at.
order: 'desc', # String | Order direction. Can be one of: asc, desc.
- q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | q_description_placeholder
+ q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | Specify a query to find translations by content (including wildcards).<br><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
}
begin
#List translations by locale
result = api_instance.translations_by_locale(project_id, locale_id, opts)
@@ -683,11 +674,11 @@
**page** | **Integer**| Page number | [optional]
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 10 by default | [optional]
**branch** | **String**| specify the branch to use | [optional]
**sort** | **String**| Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
- **q** | **String**| q_description_placeholder | [optional]
+ **q** | **String**| Specify a query to find translations by content (including wildcards).<br><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. | [optional]
### Return type
Response<([**Array<Translation>**](Translation.md))>
@@ -720,12 +711,11 @@
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token
config.api_key['Authorization'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['Authorization'] = 'Bearer'
+ config.api_key_prefix['Authorization'] = 'token'
end
api_instance = Phrase::TranslationsApi.new
project_id = 'project_id_example' # String | Project ID
translations_exclude_parameters = Phrase::TranslationsExcludeParameters.new # TranslationsExcludeParameters |
@@ -784,12 +774,11 @@
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token
config.api_key['Authorization'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['Authorization'] = 'Bearer'
+ config.api_key_prefix['Authorization'] = 'token'
end
api_instance = Phrase::TranslationsApi.new
project_id = 'project_id_example' # String | Project ID
translations_include_parameters = Phrase::TranslationsIncludeParameters.new # TranslationsIncludeParameters |
@@ -848,12 +837,11 @@
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token
config.api_key['Authorization'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['Authorization'] = 'Bearer'
+ config.api_key_prefix['Authorization'] = 'token'
end
api_instance = Phrase::TranslationsApi.new
project_id = 'project_id_example' # String | Project ID
opts = {
@@ -861,11 +849,11 @@
page: 1, # Integer | Page number
per_page: 10, # Integer | allows you to specify a page size up to 100 items, 10 by default
branch: 'my-feature-branch', # String | specify the branch to use
sort: 'updated_at', # String | Sort criteria. Can be one of: key_name, created_at, updated_at.
order: 'desc', # String | Order direction. Can be one of: asc, desc.
- q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | q_description_placeholder
+ q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | Specify a query to find translations by content (including wildcards).<br><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
}
begin
#List all translations
result = api_instance.translations_list(project_id, opts)
@@ -885,11 +873,11 @@
**page** | **Integer**| Page number | [optional]
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 10 by default | [optional]
**branch** | **String**| specify the branch to use | [optional]
**sort** | **String**| Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
- **q** | **String**| q_description_placeholder | [optional]
+ **q** | **String**| Specify a query to find translations by content (including wildcards).<br><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. | [optional]
### Return type
Response<([**Array<Translation>**](Translation.md))>
@@ -922,12 +910,11 @@
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token
config.api_key['Authorization'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['Authorization'] = 'Bearer'
+ config.api_key_prefix['Authorization'] = 'token'
end
api_instance = Phrase::TranslationsApi.new
project_id = 'project_id_example' # String | Project ID
translations_review_parameters = Phrase::TranslationsReviewParameters.new # TranslationsReviewParameters |
@@ -986,12 +973,11 @@
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token
config.api_key['Authorization'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['Authorization'] = 'Bearer'
+ config.api_key_prefix['Authorization'] = 'token'
end
api_instance = Phrase::TranslationsApi.new
project_id = 'project_id_example' # String | Project ID
translations_search_parameters = Phrase::TranslationsSearchParameters.new # TranslationsSearchParameters |
@@ -1054,12 +1040,11 @@
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token
config.api_key['Authorization'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['Authorization'] = 'Bearer'
+ config.api_key_prefix['Authorization'] = 'token'
end
api_instance = Phrase::TranslationsApi.new
project_id = 'project_id_example' # String | Project ID
translations_unverify_parameters = Phrase::TranslationsUnverifyParameters.new # TranslationsUnverifyParameters |
@@ -1118,11 +1103,10 @@
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token
config.api_key['Authorization'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['Authorization'] = 'Bearer'
+ config.api_key_prefix['Authorization'] = 'token'
end
api_instance = Phrase::TranslationsApi.new
project_id = 'project_id_example' # String | Project ID
translations_verify_parameters = Phrase::TranslationsVerifyParameters.new # TranslationsVerifyParameters |