lib/phrase/api/jobs_api.rb in phrase-2.6.0 vs lib/phrase/api/jobs_api.rb in phrase-2.7.0

- old
+ new

@@ -388,10 +388,83 @@ end response = ::Phrase::Response.new(data, headers) return response, status_code, headers end + # Lock a job + # If you are the job owner, you may lock a job using this API request. + # @param project_id [String] Project ID + # @param id [String] ID + # @param [Hash] opts the optional parameters + # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional) + # @option opts [String] :branch specify the branch to use + # @return [nil] + def job_lock(project_id, id, opts = {}) + data, _status_code, _headers = job_lock_with_http_info(project_id, id, opts) + data + end + + # Lock a job + # If you are the job owner, you may lock a job using this API request. + # @param project_id [String] Project ID + # @param id [String] ID + # @param [Hash] opts the optional parameters + # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional) + # @option opts [String] :branch specify the branch to use + # @return [Array<(Response, Integer, Hash)>] Response<(nil, response status code and response headers + def job_lock_with_http_info(project_id, id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: JobsApi.job_lock ...' + end + # verify the required parameter 'project_id' is set + if @api_client.config.client_side_validation && project_id.nil? + fail ArgumentError, "Missing the required parameter 'project_id' when calling JobsApi.job_lock" + end + # verify the required parameter 'id' is set + if @api_client.config.client_side_validation && id.nil? + fail ArgumentError, "Missing the required parameter 'id' when calling JobsApi.job_lock" + end + # resource path + local_var_path = '/projects/{project_id}/jobs/{id}/lock'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil? + + # header parameters + header_params = opts[:header_params] || {} + header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil? + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['Basic', 'Token'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: JobsApi#job_lock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + response = ::Phrase::Response.new(data, headers) + return response, status_code, headers + end + # Reopen a job # Mark a job as uncompleted. # @param project_id [String] Project ID # @param id [String] ID # @param job_reopen_parameters [JobReopenParameters] @@ -618,9 +691,82 @@ ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: JobsApi#job_start\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + response = ::Phrase::Response.new(data, headers) + return response, status_code, headers + end + + # Unlock a job + # If you are the job owner, you may unlock a locked job using this API request. + # @param project_id [String] Project ID + # @param id [String] ID + # @param [Hash] opts the optional parameters + # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional) + # @option opts [String] :branch specify the branch to use + # @return [nil] + def job_unlock(project_id, id, opts = {}) + data, _status_code, _headers = job_unlock_with_http_info(project_id, id, opts) + data + end + + # Unlock a job + # If you are the job owner, you may unlock a locked job using this API request. + # @param project_id [String] Project ID + # @param id [String] ID + # @param [Hash] opts the optional parameters + # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional) + # @option opts [String] :branch specify the branch to use + # @return [Array<(Response, Integer, Hash)>] Response<(nil, response status code and response headers + def job_unlock_with_http_info(project_id, id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: JobsApi.job_unlock ...' + end + # verify the required parameter 'project_id' is set + if @api_client.config.client_side_validation && project_id.nil? + fail ArgumentError, "Missing the required parameter 'project_id' when calling JobsApi.job_unlock" + end + # verify the required parameter 'id' is set + if @api_client.config.client_side_validation && id.nil? + fail ArgumentError, "Missing the required parameter 'id' when calling JobsApi.job_unlock" + end + # resource path + local_var_path = '/projects/{project_id}/jobs/{id}/unlock'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil? + + # header parameters + header_params = opts[:header_params] || {} + header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil? + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['Basic', 'Token'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: JobsApi#job_unlock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end response = ::Phrase::Response.new(data, headers) return response, status_code, headers end