docs/JobTemplatesApi.md in phrase-2.8.3 vs docs/JobTemplatesApi.md in phrase-2.8.7

- old
+ new

@@ -4,19 +4,19 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**job_template_create**](JobTemplatesApi.md#job_template_create) | **POST** /projects/{project_id}/job_templates | Create a job template [**job_template_delete**](JobTemplatesApi.md#job_template_delete) | **DELETE** /projects/{project_id}/job_templates/{id} | Delete a job template -[**job_template_show**](JobTemplatesApi.md#job_template_show) | **GET** /projects/{project_id}/job_templates/{id} | Get a single job template [**job_template_update**](JobTemplatesApi.md#job_template_update) | **PATCH** /projects/{project_id}/job_templates/{id} | Update a job template [**job_templates_list**](JobTemplatesApi.md#job_templates_list) | **GET** /projects/{project_id}/job_templates | List job templates +[**job_templates_show**](JobTemplatesApi.md#job_templates_show) | **GET** /projects/{project_id}/job_templates/{id} | Get a single job template ## job_template_create -> Object job_template_create(project_id, job_template_create_parameters, opts) +> JobTemplateDetails job_template_create(project_id, job_template_create_parameters, opts) Create a job template Create a new job template. @@ -61,11 +61,11 @@ **job_template_create_parameters** | [**JobTemplateCreateParameters**](JobTemplateCreateParameters.md)| | **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] ### Return type -Response<(**Object**)> +Response<([**JobTemplateDetails**](JobTemplateDetails.md))> ### Authorization [Basic](../README.md#Basic), [Token](../README.md#Token) @@ -137,17 +137,17 @@ - **Content-Type**: Not defined - **Accept**: Not defined -## job_template_show +## job_template_update -> Object job_template_show(project_id, id, opts) +> JobTemplateDetails job_template_update(project_id, id, job_template_update_parameters, opts) -Get a single job template +Update a job template -Get details on a single job template for a given project. +Update an existing job template. ### Example ```ruby # load the gem @@ -164,55 +164,55 @@ end api_instance = Phrase::JobTemplatesApi.new project_id = 'project_id_example' # String | Project ID id = 'id_example' # String | ID +job_template_update_parameters = Phrase::JobTemplateUpdateParameters.new # JobTemplateUpdateParameters | 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 + x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional) } begin - #Get a single job template - result = api_instance.job_template_show(project_id, id, opts) + #Update a job template + result = api_instance.job_template_update(project_id, id, job_template_update_parameters, opts) pp result rescue Phrase::ApiError => e - puts "Exception when calling JobTemplatesApi->job_template_show: #{e}" + puts "Exception when calling JobTemplatesApi->job_template_update: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **project_id** | **String**| Project ID | **id** | **String**| ID | + **job_template_update_parameters** | [**JobTemplateUpdateParameters**](JobTemplateUpdateParameters.md)| | **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] - **branch** | **String**| specify the branch to use | [optional] ### Return type -Response<(**Object**)> +Response<([**JobTemplateDetails**](JobTemplateDetails.md))> ### Authorization [Basic](../README.md#Basic), [Token](../README.md#Token) ### HTTP request headers -- **Content-Type**: Not defined +- **Content-Type**: application/json - **Accept**: application/json -## job_template_update +## job_templates_list -> Object job_template_update(project_id, id, job_template_update_parameters, opts) +> Array&lt;JobTemplate&gt; job_templates_list(project_id, opts) -Update a job template +List job templates -Update an existing job template. +List all job templates for the given project. ### Example ```ruby # load the gem @@ -228,56 +228,58 @@ config.api_key_prefix['Authorization'] = 'token' end api_instance = Phrase::JobTemplatesApi.new project_id = 'project_id_example' # String | Project ID -id = 'id_example' # String | ID -job_template_update_parameters = Phrase::JobTemplateUpdateParameters.new # JobTemplateUpdateParameters | opts = { - x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional) + 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 } begin - #Update a job template - result = api_instance.job_template_update(project_id, id, job_template_update_parameters, opts) + #List job templates + result = api_instance.job_templates_list(project_id, opts) pp result rescue Phrase::ApiError => e - puts "Exception when calling JobTemplatesApi->job_template_update: #{e}" + puts "Exception when calling JobTemplatesApi->job_templates_list: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **project_id** | **String**| Project ID | - **id** | **String**| ID | - **job_template_update_parameters** | [**JobTemplateUpdateParameters**](JobTemplateUpdateParameters.md)| | **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] ### Return type -Response<(**Object**)> +Response<([**Array&lt;JobTemplate&gt;**](JobTemplate.md))> ### Authorization [Basic](../README.md#Basic), [Token](../README.md#Token) ### HTTP request headers -- **Content-Type**: application/json +- **Content-Type**: Not defined - **Accept**: application/json -## job_templates_list +## job_templates_show -> Array&lt;JobTemplate&gt; job_templates_list(project_id, opts) +> JobTemplateDetails job_templates_show(project_id, id, opts) -List job templates +Get a single job template -List all job templates for the given project. +Get details on a single job template for a given project. ### Example ```ruby # load the gem @@ -293,39 +295,37 @@ config.api_key_prefix['Authorization'] = 'token' end api_instance = Phrase::JobTemplatesApi.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) - 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 } begin - #List job templates - result = api_instance.job_templates_list(project_id, opts) + #Get a single job template + result = api_instance.job_templates_show(project_id, id, opts) pp result rescue Phrase::ApiError => e - puts "Exception when calling JobTemplatesApi->job_templates_list: #{e}" + puts "Exception when calling JobTemplatesApi->job_templates_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] - **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] ### Return type -Response<([**Array&lt;JobTemplate&gt;**](JobTemplate.md))> +Response<([**JobTemplateDetails**](JobTemplateDetails.md))> ### Authorization [Basic](../README.md#Basic), [Token](../README.md#Token)