Class: SurveyMonkeySwaggerClient::TranslationsForMultilingualSurveysApi

Inherits:
Object
  • Object
show all
Defined in:
lib/survey_monkey_swagger_client/api/translations_for_multilingual_surveys_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TranslationsForMultilingualSurveysApi

Returns a new instance of TranslationsForMultilingualSurveysApi.



16
17
18
 
# File 'lib/survey_monkey_swagger_client/api/translations_for_multilingual_surveys_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/survey_monkey_swagger_client/api/translations_for_multilingual_surveys_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#create_a_translation(survey_id, locale, opts = {}) ⇒ nil

Create a translation Create a translation

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


26
27
28
29
 
# File 'lib/survey_monkey_swagger_client/api/translations_for_multilingual_surveys_api.rb', line 26

def create_a_translation(survey_id, locale, opts = {})
  create_a_translation_with_http_info(survey_id, locale, opts)
  nil
end

#create_a_translation_with_http_info(survey_id, locale, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Create a translation Create a translation

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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/survey_monkey_swagger_client/api/translations_for_multilingual_surveys_api.rb', line 38

def create_a_translation_with_http_info(survey_id, locale, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TranslationsForMultilingualSurveysApi.create_a_translation ...'
  end
  # verify the required parameter 'survey_id' is set
  if @api_client.config.client_side_validation && survey_id.nil?
    fail ArgumentError, "Missing the required parameter 'survey_id' when calling TranslationsForMultilingualSurveysApi.create_a_translation"
  end
  # verify the required parameter 'locale' is set
  if @api_client.config.client_side_validation && locale.nil?
    fail ArgumentError, "Missing the required parameter 'locale' when calling TranslationsForMultilingualSurveysApi.create_a_translation"
  end
  # resource path
  local_var_path = '/v3/surveys/{survey_id}/languages/{locale}'.sub('{' + 'survey_id' + '}', survey_id.to_s).sub('{' + 'locale' + '}', locale.to_s)

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])

  return_type = opts[:return_type]

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TranslationsForMultilingualSurveysApi#create_a_translation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_a_survey_translation(survey_id, opts = {}) ⇒ nil

Get a survey translation Get a survey translation

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


88
89
90
91
 
# File 'lib/survey_monkey_swagger_client/api/translations_for_multilingual_surveys_api.rb', line 88

def get_a_survey_translation(survey_id, opts = {})
  get_a_survey_translation_with_http_info(survey_id, opts)
  nil
end

#get_a_survey_translation_with_http_info(survey_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get a survey translation Get a survey translation

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/survey_monkey_swagger_client/api/translations_for_multilingual_surveys_api.rb', line 98

def get_a_survey_translation_with_http_info(survey_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TranslationsForMultilingualSurveysApi.get_a_survey_translation ...'
  end
  # verify the required parameter 'survey_id' is set
  if @api_client.config.client_side_validation && survey_id.nil?
    fail ArgumentError, "Missing the required parameter 'survey_id' when calling TranslationsForMultilingualSurveysApi.get_a_survey_translation"
  end
  # resource path
  local_var_path = '/v3/surveys/{survey_id}/languages'.sub('{' + 'survey_id' + '}', survey_id.to_s)

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

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type]

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TranslationsForMultilingualSurveysApi#get_a_survey_translation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_available_languages(opts = {}) ⇒ nil

Get available languages Get available languages

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


141
142
143
144
 
# File 'lib/survey_monkey_swagger_client/api/translations_for_multilingual_surveys_api.rb', line 141

def get_available_languages(opts = {})
  get_available_languages_with_http_info(opts)
  nil
end

#get_available_languages_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get available languages Get available languages

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/survey_monkey_swagger_client/api/translations_for_multilingual_surveys_api.rb', line 150

def get_available_languages_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TranslationsForMultilingualSurveysApi.get_available_languages ...'
  end
  # resource path
  local_var_path = '/v3/survey_languages'

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

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type]

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TranslationsForMultilingualSurveysApi#get_available_languages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_translation_structure(survey_id, locale, opts = {}) ⇒ nil

Get translation structure Get translation structure

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


191
192
193
194
 
# File 'lib/survey_monkey_swagger_client/api/translations_for_multilingual_surveys_api.rb', line 191

def get_translation_structure(survey_id, locale, opts = {})
  get_translation_structure_with_http_info(survey_id, locale, opts)
  nil
end

#get_translation_structure_with_http_info(survey_id, locale, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get translation structure Get translation structure

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/survey_monkey_swagger_client/api/translations_for_multilingual_surveys_api.rb', line 202

def get_translation_structure_with_http_info(survey_id, locale, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TranslationsForMultilingualSurveysApi.get_translation_structure ...'
  end
  # verify the required parameter 'survey_id' is set
  if @api_client.config.client_side_validation && survey_id.nil?
    fail ArgumentError, "Missing the required parameter 'survey_id' when calling TranslationsForMultilingualSurveysApi.get_translation_structure"
  end
  # verify the required parameter 'locale' is set
  if @api_client.config.client_side_validation && locale.nil?
    fail ArgumentError, "Missing the required parameter 'locale' when calling TranslationsForMultilingualSurveysApi.get_translation_structure"
  end
  # resource path
  local_var_path = '/v3/surveys/{survey_id}/languages/{locale}'.sub('{' + 'survey_id' + '}', survey_id.to_s).sub('{' + 'locale' + '}', locale.to_s)

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

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type]

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TranslationsForMultilingualSurveysApi#get_translation_structure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#modify_a_translation(survey_id, locale, opts = {}) ⇒ nil

Modify a translation Modify a translation

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


252
253
254
255
 
# File 'lib/survey_monkey_swagger_client/api/translations_for_multilingual_surveys_api.rb', line 252

def modify_a_translation(survey_id, locale, opts = {})
  modify_a_translation_with_http_info(survey_id, locale, opts)
  nil
end

#modify_a_translation_with_http_info(survey_id, locale, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Modify a translation Modify a translation

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/survey_monkey_swagger_client/api/translations_for_multilingual_surveys_api.rb', line 264

def modify_a_translation_with_http_info(survey_id, locale, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TranslationsForMultilingualSurveysApi.modify_a_translation ...'
  end
  # verify the required parameter 'survey_id' is set
  if @api_client.config.client_side_validation && survey_id.nil?
    fail ArgumentError, "Missing the required parameter 'survey_id' when calling TranslationsForMultilingualSurveysApi.modify_a_translation"
  end
  # verify the required parameter 'locale' is set
  if @api_client.config.client_side_validation && locale.nil?
    fail ArgumentError, "Missing the required parameter 'locale' when calling TranslationsForMultilingualSurveysApi.modify_a_translation"
  end
  # resource path
  local_var_path = '/v3/surveys/{survey_id}/languages/{locale}'.sub('{' + 'survey_id' + '}', survey_id.to_s).sub('{' + 'locale' + '}', locale.to_s)

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])

  return_type = opts[:return_type]

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TranslationsForMultilingualSurveysApi#modify_a_translation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end