Class: Notifo::EmailTemplatesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/notifo/api/email_templates_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EmailTemplatesApi

Returns a new instance of EmailTemplatesApi.



16
17
18
# File 'lib/notifo/api/email_templates_api.rb', line 16

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



14
15
16
# File 'lib/notifo/api/email_templates_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#email_template_preview_get_preview(app_id, id, opts = {}) ⇒ String

Get the HTML preview for a channel template.

Parameters:

  • app_id

    The id of the app where the templates belong to.

  • id

    The template ID.

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

    the optional parameters

Returns:

  • (String)


24
25
26
27
# File 'lib/notifo/api/email_templates_api.rb', line 24

def email_template_preview_get_preview(app_id, id, opts = {})
  data, _status_code, _headers = email_template_preview_get_preview_with_http_info(app_id, id, opts)
  data
end

#email_template_preview_get_preview_with_http_info(app_id, id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Get the HTML preview for a channel template.

Parameters:

  • app_id

    The id of the app where the templates belong to.

  • id

    The template ID.

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

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>)

    String data, response status code and response headers



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
# File 'lib/notifo/api/email_templates_api.rb', line 34

def email_template_preview_get_preview_with_http_info(app_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailTemplatesApi.email_template_preview_get_preview ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling EmailTemplatesApi.email_template_preview_get_preview"
  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 EmailTemplatesApi.email_template_preview_get_preview"
  end
  # resource path
  local_var_path = '/api/apps/{appId}/email-templates/{id}/preview'.sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'id' + '}', 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/octet-stream', 'application/json'])

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

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

  return_type = opts[:return_type] || 'String' 

  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: EmailTemplatesApi#email_template_preview_get_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#email_template_preview_post_preview(body, app_id, opts = {}) ⇒ EmailPreviewDto

Render a preview for a email template.

Parameters:

  • body

    The template to render.

  • app_id

    The id of the app where the templates belong to.

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

    the optional parameters

Returns:



84
85
86
87
# File 'lib/notifo/api/email_templates_api.rb', line 84

def email_template_preview_post_preview(body, app_id, opts = {})
  data, _status_code, _headers = email_template_preview_post_preview_with_http_info(body, app_id, opts)
  data
end

#email_template_preview_post_preview_with_http_info(body, app_id, opts = {}) ⇒ Array<(EmailPreviewDto, Integer, Hash)>

Render a preview for a email template.

Parameters:

  • body

    The template to render.

  • app_id

    The id of the app where the templates belong to.

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

    the optional parameters

Returns:

  • (Array<(EmailPreviewDto, Integer, Hash)>)

    EmailPreviewDto data, response status code and response headers



94
95
96
97
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
137
138
139
140
# File 'lib/notifo/api/email_templates_api.rb', line 94

def email_template_preview_post_preview_with_http_info(body, app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailTemplatesApi.email_template_preview_post_preview ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling EmailTemplatesApi.email_template_preview_post_preview"
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling EmailTemplatesApi.email_template_preview_post_preview"
  end
  # resource path
  local_var_path = '/api/apps/{appId}/email-templates/render'.sub('{' + 'appId' + '}', app_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'])

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

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

  return_type = opts[:return_type] || 'EmailPreviewDto' 

  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: EmailTemplatesApi#email_template_preview_post_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#email_templates_delete_template(app_id, code, opts = {}) ⇒ nil

Delete a channel template.

Parameters:

  • app_id

    The id of the app where the templates belong to.

  • code

    The template ID.

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

    the optional parameters

Returns:

  • (nil)


146
147
148
149
# File 'lib/notifo/api/email_templates_api.rb', line 146

def email_templates_delete_template(app_id, code, opts = {})
  email_templates_delete_template_with_http_info(app_id, code, opts)
  nil
end

#email_templates_delete_template_language(app_id, code, language, opts = {}) ⇒ nil

Delete a language channel template.

Parameters:

  • app_id

    The id of the app where the templates belong to.

  • code

    The template ID.

  • language

    The language.

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

    the optional parameters

Returns:

  • (nil)


207
208
209
210
# File 'lib/notifo/api/email_templates_api.rb', line 207

def email_templates_delete_template_language(app_id, code, language, opts = {})
  email_templates_delete_template_language_with_http_info(app_id, code, language, opts)
  nil
end

#email_templates_delete_template_language_with_http_info(app_id, code, language, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a language channel template.

Parameters:

  • app_id

    The id of the app where the templates belong to.

  • code

    The template ID.

  • language

    The language.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
# File 'lib/notifo/api/email_templates_api.rb', line 218

def email_templates_delete_template_language_with_http_info(app_id, code, language, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailTemplatesApi.email_templates_delete_template_language ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling EmailTemplatesApi.email_templates_delete_template_language"
  end
  # verify the required parameter 'code' is set
  if @api_client.config.client_side_validation && code.nil?
    fail ArgumentError, "Missing the required parameter 'code' when calling EmailTemplatesApi.email_templates_delete_template_language"
  end
  # verify the required parameter 'language' is set
  if @api_client.config.client_side_validation && language.nil?
    fail ArgumentError, "Missing the required parameter 'language' when calling EmailTemplatesApi.email_templates_delete_template_language"
  end
  # resource path
  local_var_path = '/api/apps/{appId}/email-templates/{code}/{language}'.sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'code' + '}', code.to_s).sub('{' + 'language' + '}', language.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'])

  # 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(:DELETE, 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: EmailTemplatesApi#email_templates_delete_template_language\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#email_templates_delete_template_with_http_info(app_id, code, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a channel template.

Parameters:

  • app_id

    The id of the app where the templates belong to.

  • code

    The template ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
# File 'lib/notifo/api/email_templates_api.rb', line 156

def email_templates_delete_template_with_http_info(app_id, code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailTemplatesApi.email_templates_delete_template ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling EmailTemplatesApi.email_templates_delete_template"
  end
  # verify the required parameter 'code' is set
  if @api_client.config.client_side_validation && code.nil?
    fail ArgumentError, "Missing the required parameter 'code' when calling EmailTemplatesApi.email_templates_delete_template"
  end
  # resource path
  local_var_path = '/api/apps/{appId}/email-templates/{code}'.sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'code' + '}', code.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'])

  # 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(:DELETE, 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: EmailTemplatesApi#email_templates_delete_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#email_templates_get_template(app_id, id, opts = {}) ⇒ ChannelTemplateDetailsDtoOfEmailTemplateDto

Get the channel template by id.

Parameters:

  • app_id

    The id of the app where the templates belong to.

  • id

    The template ID.

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

    the optional parameters

Returns:



272
273
274
275
# File 'lib/notifo/api/email_templates_api.rb', line 272

def email_templates_get_template(app_id, id, opts = {})
  data, _status_code, _headers = email_templates_get_template_with_http_info(app_id, id, opts)
  data
end

#email_templates_get_template_with_http_info(app_id, id, opts = {}) ⇒ Array<(ChannelTemplateDetailsDtoOfEmailTemplateDto, Integer, Hash)>

Get the channel template by id.

Parameters:

  • app_id

    The id of the app where the templates belong to.

  • id

    The template ID.

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

    the optional parameters

Returns:



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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
# File 'lib/notifo/api/email_templates_api.rb', line 282

def email_templates_get_template_with_http_info(app_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailTemplatesApi.email_templates_get_template ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling EmailTemplatesApi.email_templates_get_template"
  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 EmailTemplatesApi.email_templates_get_template"
  end
  # resource path
  local_var_path = '/api/apps/{appId}/email-templates/{id}'.sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'id' + '}', 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'])

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

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

  return_type = opts[:return_type] || 'ChannelTemplateDetailsDtoOfEmailTemplateDto' 

  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: EmailTemplatesApi#email_templates_get_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#email_templates_get_templates(app_id, opts = {}) ⇒ ListResponseDtoOfChannelTemplateDto

Get the channel templates.

Parameters:

  • app_id

    The id of the app where the templates belong to.

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

    the optional parameters

Options Hash (opts):

  • :query (String)

    The optional query to search for items.

  • :take (Integer)

    The number of items to return.

  • :skip (Integer)

    The number of items to skip.

Returns:



334
335
336
337
# File 'lib/notifo/api/email_templates_api.rb', line 334

def email_templates_get_templates(app_id, opts = {})
  data, _status_code, _headers = email_templates_get_templates_with_http_info(app_id, opts)
  data
end

#email_templates_get_templates_with_http_info(app_id, opts = {}) ⇒ Array<(ListResponseDtoOfChannelTemplateDto, Integer, Hash)>

Get the channel templates.

Parameters:

  • app_id

    The id of the app where the templates belong to.

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

    the optional parameters

Options Hash (opts):

  • :query (String)

    The optional query to search for items.

  • :take (Integer)

    The number of items to return.

  • :skip (Integer)

    The number of items to skip.

Returns:



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
# File 'lib/notifo/api/email_templates_api.rb', line 346

def email_templates_get_templates_with_http_info(app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailTemplatesApi.email_templates_get_templates ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling EmailTemplatesApi.email_templates_get_templates"
  end
  # resource path
  local_var_path = '/api/apps/{appId}/email-templates'.sub('{' + 'appId' + '}', app_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'take'] = opts[:'take'] if !opts[:'take'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

  return_type = opts[:return_type] || 'ListResponseDtoOfChannelTemplateDto' 

  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: EmailTemplatesApi#email_templates_get_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#email_templates_post_template(body, app_id, opts = {}) ⇒ ChannelTemplateDetailsDtoOfEmailTemplateDto

Create a channel template.

Parameters:

  • body

    The request object.

  • app_id

    The id of the app where the templates belong to.

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

    the optional parameters

Returns:



395
396
397
398
# File 'lib/notifo/api/email_templates_api.rb', line 395

def email_templates_post_template(body, app_id, opts = {})
  data, _status_code, _headers = email_templates_post_template_with_http_info(body, app_id, opts)
  data
end

#email_templates_post_template_language(body, app_id, code, opts = {}) ⇒ EmailTemplateDto

Create an app template language.

Parameters:

  • body

    The request object.

  • app_id

    The id of the app where the templates belong to.

  • code

    The template code.

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

    the optional parameters

Returns:



458
459
460
461
# File 'lib/notifo/api/email_templates_api.rb', line 458

def email_templates_post_template_language(body, app_id, code, opts = {})
  data, _status_code, _headers = email_templates_post_template_language_with_http_info(body, app_id, code, opts)
  data
end

#email_templates_post_template_language_with_http_info(body, app_id, code, opts = {}) ⇒ Array<(EmailTemplateDto, Integer, Hash)>

Create an app template language.

Parameters:

  • body

    The request object.

  • app_id

    The id of the app where the templates belong to.

  • code

    The template code.

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

    the optional parameters

Returns:

  • (Array<(EmailTemplateDto, Integer, Hash)>)

    EmailTemplateDto data, response status code and response headers



469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
# File 'lib/notifo/api/email_templates_api.rb', line 469

def email_templates_post_template_language_with_http_info(body, app_id, code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailTemplatesApi.email_templates_post_template_language ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling EmailTemplatesApi.email_templates_post_template_language"
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling EmailTemplatesApi.email_templates_post_template_language"
  end
  # verify the required parameter 'code' is set
  if @api_client.config.client_side_validation && code.nil?
    fail ArgumentError, "Missing the required parameter 'code' when calling EmailTemplatesApi.email_templates_post_template_language"
  end
  # resource path
  local_var_path = '/api/apps/{appId}/email-templates/{code}'.sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'code' + '}', code.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'])

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

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

  return_type = opts[:return_type] || 'EmailTemplateDto' 

  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: EmailTemplatesApi#email_templates_post_template_language\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#email_templates_post_template_with_http_info(body, app_id, opts = {}) ⇒ Array<(ChannelTemplateDetailsDtoOfEmailTemplateDto, Integer, Hash)>

Create a channel template.

Parameters:

  • body

    The request object.

  • app_id

    The id of the app where the templates belong to.

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

    the optional parameters

Returns:



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
# File 'lib/notifo/api/email_templates_api.rb', line 405

def email_templates_post_template_with_http_info(body, app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailTemplatesApi.email_templates_post_template ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling EmailTemplatesApi.email_templates_post_template"
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling EmailTemplatesApi.email_templates_post_template"
  end
  # resource path
  local_var_path = '/api/apps/{appId}/email-templates'.sub('{' + 'appId' + '}', app_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'])

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

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

  return_type = opts[:return_type] || 'ChannelTemplateDetailsDtoOfEmailTemplateDto' 

  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: EmailTemplatesApi#email_templates_post_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#email_templates_put_template(body, app_id, code, opts = {}) ⇒ nil

Update an app template.

Parameters:

  • body

    The request object.

  • app_id

    The id of the app where the templates belong to.

  • code

    The template code.

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

    the optional parameters

Returns:

  • (nil)


526
527
528
529
# File 'lib/notifo/api/email_templates_api.rb', line 526

def email_templates_put_template(body, app_id, code, opts = {})
  email_templates_put_template_with_http_info(body, app_id, code, opts)
  nil
end

#email_templates_put_template_language(body, app_id, code, language, opts = {}) ⇒ nil

Update a channel template language.

Parameters:

  • body

    The request object.

  • app_id

    The id of the app where the templates belong to.

  • code

    The template code.

  • language

    The language.

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

    the optional parameters

Returns:

  • (nil)


595
596
597
598
# File 'lib/notifo/api/email_templates_api.rb', line 595

def email_templates_put_template_language(body, app_id, code, language, opts = {})
  email_templates_put_template_language_with_http_info(body, app_id, code, language, opts)
  nil
end

#email_templates_put_template_language_with_http_info(body, app_id, code, language, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update a channel template language.

Parameters:

  • body

    The request object.

  • app_id

    The id of the app where the templates belong to.

  • code

    The template code.

  • language

    The language.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
# File 'lib/notifo/api/email_templates_api.rb', line 607

def email_templates_put_template_language_with_http_info(body, app_id, code, language, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailTemplatesApi.email_templates_put_template_language ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling EmailTemplatesApi.email_templates_put_template_language"
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling EmailTemplatesApi.email_templates_put_template_language"
  end
  # verify the required parameter 'code' is set
  if @api_client.config.client_side_validation && code.nil?
    fail ArgumentError, "Missing the required parameter 'code' when calling EmailTemplatesApi.email_templates_put_template_language"
  end
  # verify the required parameter 'language' is set
  if @api_client.config.client_side_validation && language.nil?
    fail ArgumentError, "Missing the required parameter 'language' when calling EmailTemplatesApi.email_templates_put_template_language"
  end
  # resource path
  local_var_path = '/api/apps/{appId}/email-templates/{code}/{language}'.sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'code' + '}', code.to_s).sub('{' + 'language' + '}', language.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'])

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

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

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, 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: EmailTemplatesApi#email_templates_put_template_language\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#email_templates_put_template_with_http_info(body, app_id, code, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update an app template.

Parameters:

  • body

    The request object.

  • app_id

    The id of the app where the templates belong to.

  • code

    The template code.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
# File 'lib/notifo/api/email_templates_api.rb', line 537

def email_templates_put_template_with_http_info(body, app_id, code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailTemplatesApi.email_templates_put_template ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling EmailTemplatesApi.email_templates_put_template"
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling EmailTemplatesApi.email_templates_put_template"
  end
  # verify the required parameter 'code' is set
  if @api_client.config.client_side_validation && code.nil?
    fail ArgumentError, "Missing the required parameter 'code' when calling EmailTemplatesApi.email_templates_put_template"
  end
  # resource path
  local_var_path = '/api/apps/{appId}/email-templates/{code}'.sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'code' + '}', code.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'])

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

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

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, 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: EmailTemplatesApi#email_templates_put_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end