docs/JobsApi.md in phrase-1.0.1 vs docs/JobsApi.md in phrase-1.0.2
- old
+ new
@@ -36,12 +36,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::JobsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
@@ -83,11 +82,11 @@
- **Accept**: application/json
## job_create
-> job_create(project_id, job_create_parameters, opts)
+> JobDetails job_create(project_id, job_create_parameters, opts)
Create a job
Create a new job.
@@ -102,12 +101,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::JobsApi.new
project_id = 'project_id_example' # String | Project ID
job_create_parameters = Phrase::JobCreateParameters.new # JobCreateParameters |
@@ -115,11 +113,12 @@
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}
begin
#Create a job
- api_instance.job_create(project_id, job_create_parameters, opts)
+ 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
```
@@ -132,20 +131,20 @@
**job_create_parameters** | [**JobCreateParameters**](JobCreateParameters.md)| |
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
### Return type
-Response<(nil (empty response body))>
+Response<([**JobDetails**](JobDetails.md))>
### Authorization
[Basic](../README.md#Basic), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json
-- **Accept**: Not defined
+- **Accept**: application/json
## job_delete
> job_delete(project_id, id, opts)
@@ -165,12 +164,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::JobsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
@@ -230,12 +228,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::JobsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
@@ -296,12 +293,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::JobsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
@@ -363,12 +359,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::JobsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
@@ -429,12 +424,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::JobsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
@@ -495,12 +489,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::JobsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
@@ -561,12 +554,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::JobsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
@@ -627,11 +619,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::JobsApi.new
project_id = 'project_id_example' # String | Project ID
opts = {