Class: Phrase::ICUApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ICUApi

Returns a new instance of ICUApi.



7
8
9
 
# File 'lib/phrase/api/icu_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/icu_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#icu_skeleton(icu_skeleton_parameters, opts = {}) ⇒ Icu

Build ICU skeletons Generates ICU (International Components for Unicode) message format skeletons for a given source string across one or more locales. An ICU skeleton strips the literal text from a pluralized or select message while preserving its structural rules — argument names, plural categories, select cases, and ordinal forms — adjusted to the pluralization rules of each requested locale. Use this endpoint to normalize translation templates before importing them into locale files, or to validate that a source string carries the plural forms required by a target language. Either content or id must be provided — supplying both or neither returns 400. When id is used and the referenced translation does not exist, the endpoint returns 404. When the source string is not valid ICU message format syntax, the endpoint returns 422 with an error field describing the parse failure.

Parameters:

  • icu_skeleton_parameters (IcuSkeletonParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



16
17
18
19
 
# File 'lib/phrase/api/icu_api.rb', line 16

def icu_skeleton(icu_skeleton_parameters, opts = {})
  data, _status_code, _headers = icu_skeleton_with_http_info(icu_skeleton_parameters, opts)
  data
end

#icu_skeleton_with_http_info(icu_skeleton_parameters, opts = {}) ⇒ Array<(Response<(Icu)>, Integer, Hash)>

Build ICU skeletons Generates ICU (International Components for Unicode) message format skeletons for a given source string across one or more locales. An ICU skeleton strips the literal text from a pluralized or select message while preserving its structural rules — argument names, plural categories, select cases, and ordinal forms — adjusted to the pluralization rules of each requested locale. Use this endpoint to normalize translation templates before importing them into locale files, or to validate that a source string carries the plural forms required by a target language. Either `content` or `id` must be provided — supplying both or neither returns 400. When `id` is used and the referenced translation does not exist, the endpoint returns 404. When the source string is not valid ICU message format syntax, the endpoint returns 422 with an `error` field describing the parse failure.

Parameters:

  • icu_skeleton_parameters (IcuSkeletonParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

  • (Array<(Response<(Icu)>, Integer, Hash)>) —

    Response<(Icu)> data, response status code and response headers



27
28
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
 
# File 'lib/phrase/api/icu_api.rb', line 27

def icu_skeleton_with_http_info(icu_skeleton_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ICUApi.icu_skeleton ...'
  end
  # resource path
  local_var_path = '/icu/skeleton'

  # 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(icu_skeleton_parameters) 

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

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