Class: ClickSendClient::MasterEmailTemplatesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/clicksend_client/api/master_email_templates_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MasterEmailTemplatesApi

Returns a new instance of MasterEmailTemplatesApi.



19
20
21
 
# File 'lib/clicksend_client/api/master_email_templates_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/clicksend_client/api/master_email_templates_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#master_email_template_categories_get(opts = {}) ⇒ String

Get all master email template categories Get all master email template categories

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number (default to 1)

  • :limit (Integer) —

    Number of records per page (default to 10)

Returns:

  • (String) 


28
29
30
31
 
# File 'lib/clicksend_client/api/master_email_templates_api.rb', line 28

def master_email_template_categories_get(opts = {})
  data, _status_code, _headers = master_email_template_categories_get_with_http_info(opts)
  data
end

#master_email_template_categories_get_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get all master email template categories Get all master email template categories

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number

  • :limit (Integer) —

    Number of records per page

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
 
# File 'lib/clicksend_client/api/master_email_templates_api.rb', line 39

def master_email_template_categories_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterEmailTemplatesApi.master_email_template_categories_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling MasterEmailTemplatesApi.master_email_template_categories_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MasterEmailTemplatesApi.master_email_template_categories_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/email/master-templates-categories'

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

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MasterEmailTemplatesApi#master_email_template_categories_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#master_email_template_category_get(category_id, opts = {}) ⇒ String

Get specific master email template category Get specific master email template category

Parameters:

  • category_id —

    Email category id

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

    the optional parameters

Returns:

  • (String) 


89
90
91
92
 
# File 'lib/clicksend_client/api/master_email_templates_api.rb', line 89

def master_email_template_category_get(category_id, opts = {})
  data, _status_code, _headers = master_email_template_category_get_with_http_info(category_id, opts)
  data
end

#master_email_template_category_get_with_http_info(category_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get specific master email template category Get specific master email template category

Parameters:

  • category_id —

    Email category id

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

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
 
# File 'lib/clicksend_client/api/master_email_templates_api.rb', line 99

def master_email_template_category_get_with_http_info(category_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterEmailTemplatesApi.master_email_template_category_get ...'
  end
  # verify the required parameter 'category_id' is set
  if @api_client.config.client_side_validation && category_id.nil?
    fail ArgumentError, "Missing the required parameter 'category_id' when calling MasterEmailTemplatesApi.master_email_template_category_get"
  end
  # resource path
  local_var_path = '/email/master-templates-categories/{category_id}'.sub('{' + 'category_id' + '}', category_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MasterEmailTemplatesApi#master_email_template_category_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#master_email_template_get(template_id, opts = {}) ⇒ String

Get specific master email template Get specific master email template

Parameters:

  • template_id —

    Email template id

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

    the optional parameters

Returns:

  • (String) 


143
144
145
146
 
# File 'lib/clicksend_client/api/master_email_templates_api.rb', line 143

def master_email_template_get(template_id, opts = {})
  data, _status_code, _headers = master_email_template_get_with_http_info(template_id, opts)
  data
end

#master_email_template_get_with_http_info(template_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get specific master email template Get specific master email template

Parameters:

  • template_id —

    Email template id

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

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
185
186
187
188
189
190
191
 
# File 'lib/clicksend_client/api/master_email_templates_api.rb', line 153

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

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MasterEmailTemplatesApi#master_email_template_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#master_email_templates_get(opts = {}) ⇒ String

Get all master email templates Get all master email templates

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number (default to 1)

  • :limit (Integer) —

    Number of records per page (default to 10)

Returns:

  • (String) 


198
199
200
201
 
# File 'lib/clicksend_client/api/master_email_templates_api.rb', line 198

def master_email_templates_get(opts = {})
  data, _status_code, _headers = master_email_templates_get_with_http_info(opts)
  data
end

#master_email_templates_get_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get all master email templates Get all master email templates

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number

  • :limit (Integer) —

    Number of records per page

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
245
246
247
248
249
250
251
252
253
 
# File 'lib/clicksend_client/api/master_email_templates_api.rb', line 209

def master_email_templates_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterEmailTemplatesApi.master_email_templates_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling MasterEmailTemplatesApi.master_email_templates_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MasterEmailTemplatesApi.master_email_templates_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/email/master-templates'

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

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MasterEmailTemplatesApi#master_email_templates_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#master_email_templates_in_category_get(category_id, opts = {}) ⇒ String

Get all master email templates in a category Get all master email templates in a category

Parameters:

  • category_id —

    Email category id

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number (default to 1)

  • :limit (Integer) —

    Number of records per page (default to 10)

Returns:

  • (String) 


261
262
263
264
 
# File 'lib/clicksend_client/api/master_email_templates_api.rb', line 261

def master_email_templates_in_category_get(category_id, opts = {})
  data, _status_code, _headers = master_email_templates_in_category_get_with_http_info(category_id, opts)
  data
end

#master_email_templates_in_category_get_with_http_info(category_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get all master email templates in a category Get all master email templates in a category

Parameters:

  • category_id —

    Email category id

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number

  • :limit (Integer) —

    Number of records per page

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/clicksend_client/api/master_email_templates_api.rb', line 273

def master_email_templates_in_category_get_with_http_info(category_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterEmailTemplatesApi.master_email_templates_in_category_get ...'
  end
  # verify the required parameter 'category_id' is set
  if @api_client.config.client_side_validation && category_id.nil?
    fail ArgumentError, "Missing the required parameter 'category_id' when calling MasterEmailTemplatesApi.master_email_templates_in_category_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling MasterEmailTemplatesApi.master_email_templates_in_category_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MasterEmailTemplatesApi.master_email_templates_in_category_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/email/master-templates-categories/{category_id}/master-templates'.sub('{' + 'category_id' + '}', category_id.to_s)

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

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MasterEmailTemplatesApi#master_email_templates_in_category_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end