Class: Phrase::VersionsHistoryApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VersionsHistoryApi

Returns a new instance of VersionsHistoryApi.



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

def api_client
  @api_client
end

Instance Method Details

#version_show(project_id, translation_id, id, opts = {}) ⇒ TranslationVersionWithUser

Get a single version Get details on a single version.

Parameters:

  • project_id (String) —

    Project ID

  • translation_id (String) —

    Translation ID

  • id (String) —

    ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    specify the branch to use

Returns:



19
20
21
22
 
# File 'lib/phrase/api/versions_history_api.rb', line 19

def version_show(project_id, translation_id, id, opts = {})
  data, _status_code, _headers = version_show_with_http_info(project_id, translation_id, id, opts)
  data
end

#version_show_with_http_info(project_id, translation_id, id, opts = {}) ⇒ Array<(Response<(TranslationVersionWithUser)>, Integer, Hash)>

Get a single version Get details on a single version.

Parameters:

  • project_id (String) —

    Project ID

  • translation_id (String) —

    Translation ID

  • id (String) —

    ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    specify the branch to use

Returns:



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
83
84
85
86
87
88
89
 
# File 'lib/phrase/api/versions_history_api.rb', line 33

def version_show_with_http_info(project_id, translation_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VersionsHistoryApi.version_show ...'
  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 VersionsHistoryApi.version_show"
  end
  # verify the required parameter 'translation_id' is set
  if @api_client.config.client_side_validation && translation_id.nil?
    fail ArgumentError, "Missing the required parameter 'translation_id' when calling VersionsHistoryApi.version_show"
  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 VersionsHistoryApi.version_show"
  end
  # resource path
  local_var_path = '/projects/{project_id}/translations/{translation_id}/versions/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'translation_id' + '}', CGI.escape(translation_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['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] 

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

  # 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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VersionsHistoryApi#version_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#versions_list(project_id, translation_id, opts = {}) ⇒ Array<TranslationVersion>

List all versions List all changes done to a given translation.

Parameters:

  • project_id (String) —

    Project ID

  • translation_id (String) —

    Translation ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :page (Integer) —

    Page number

  • :per_page (Integer) —

    Limit on the number of objects to be returned, between 1 and 100. 25 by default

  • :branch (String) —

    specify the branch to use

Returns:



101
102
103
104
 
# File 'lib/phrase/api/versions_history_api.rb', line 101

def versions_list(project_id, translation_id, opts = {})
  data, _status_code, _headers = versions_list_with_http_info(project_id, translation_id, opts)
  data
end

#versions_list_with_http_info(project_id, translation_id, opts = {}) ⇒ Array<(Response<(Array<TranslationVersion>)>, Integer, Hash)>

List all versions List all changes done to a given translation.

Parameters:

  • project_id (String) —

    Project ID

  • translation_id (String) —

    Translation ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :page (Integer) —

    Page number

  • :per_page (Integer) —

    Limit on the number of objects to be returned, between 1 and 100. 25 by default

  • :branch (String) —

    specify the branch to use

Returns:

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

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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/phrase/api/versions_history_api.rb', line 116

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['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] 

  # return_type
  return_type = opts[:return_type] || 'Array<TranslationVersion>' 

  # 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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VersionsHistoryApi#versions_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end