Class: Phrase::QualityPerformanceScoreApi

Inherits:
Object
  • Object
show all
Defined in:
lib/phrase/api/quality_performance_score_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ QualityPerformanceScoreApi

Returns a new instance of QualityPerformanceScoreApi.



7
8
9
 
# File 'lib/phrase/api/quality_performance_score_api.rb', line 7

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



5
6
7
 
# File 'lib/phrase/api/quality_performance_score_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#projects_quality_performance_score(project_id, projects_quality_performance_score_request, opts = {}) ⇒ ProjectsQualityPerformanceScore200Response

Get Translation Quality Retrieves the quality scores for your Strings translations. Returns a score, measured by Phrase QPS

Parameters:

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



17
18
19
20
 
# File 'lib/phrase/api/quality_performance_score_api.rb', line 17

def projects_quality_performance_score(project_id, projects_quality_performance_score_request, opts = {})
  data, _status_code, _headers = projects_quality_performance_score_with_http_info(project_id, projects_quality_performance_score_request, opts)
  data
end

#projects_quality_performance_score_with_http_info(project_id, projects_quality_performance_score_request, opts = {}) ⇒ Array<(Response<(ProjectsQualityPerformanceScore200Response)>, Integer, Hash)>

Get Translation Quality Retrieves the quality scores for your Strings translations. Returns a score, measured by Phrase QPS

Parameters:

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/phrase/api/quality_performance_score_api.rb', line 29

def projects_quality_performance_score_with_http_info(project_id, projects_quality_performance_score_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QualityPerformanceScoreApi.projects_quality_performance_score ...'
  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 QualityPerformanceScoreApi.projects_quality_performance_score"
  end
  # verify the required parameter 'projects_quality_performance_score_request' is set
  if @api_client.config.client_side_validation && projects_quality_performance_score_request.nil?
    fail ArgumentError, "Missing the required parameter 'projects_quality_performance_score_request' when calling QualityPerformanceScoreApi.projects_quality_performance_score"
  end
  # resource path
  local_var_path = '/projects/{project_id}/quality_performance_score'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  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] || @api_client.object_to_http_body(projects_quality_performance_score_request) 

  # return_type
  return_type = opts[:return_type] || 'ProjectsQualityPerformanceScore200Response' 

  # 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: QualityPerformanceScoreApi#projects_quality_performance_score\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end