Class: ElasticEmail::TemplatesApi
- Inherits:
-
Object
- Object
- ElasticEmail::TemplatesApi
- Defined in:
- lib/ElasticEmail/api/templates_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#initialize(api_client = ApiClient.default) ⇒ TemplatesApi
constructor
A new instance of TemplatesApi.
-
#templates_by_name_delete(name, opts = {}) ⇒ nil
Delete Template Delete template with the specified name.
-
#templates_by_name_delete_with_http_info(name, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Template Delete template with the specified name.
-
#templates_by_name_get(name, opts = {}) ⇒ Template
Load Template Load detailed information of the specified template.
-
#templates_by_name_get_with_http_info(name, opts = {}) ⇒ Array<(Template, Integer, Hash)>
Load Template Load detailed information of the specified template.
-
#templates_by_name_put(name, template_payload, opts = {}) ⇒ Template
Update Template Update existing template, overwriting existing data.
-
#templates_by_name_put_with_http_info(name, template_payload, opts = {}) ⇒ Array<(Template, Integer, Hash)>
Update Template Update existing template, overwriting existing data.
-
#templates_get(scope_type, opts = {}) ⇒ Array<Template>
Load Templates Returns a list of templates for the specified type.
-
#templates_get_with_http_info(scope_type, opts = {}) ⇒ Array<(Array<Template>, Integer, Hash)>
Load Templates Returns a list of templates for the specified type.
-
#templates_post(template_payload, opts = {}) ⇒ Template
Add Template Add a new Template.
-
#templates_post_with_http_info(template_payload, opts = {}) ⇒ Array<(Template, Integer, Hash)>
Add Template Add a new Template.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ TemplatesApi
Returns a new instance of TemplatesApi.
19 20 21 |
# File 'lib/ElasticEmail/api/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/ElasticEmail/api/templates_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#templates_by_name_delete(name, opts = {}) ⇒ nil
Delete Template Delete template with the specified name. Required Access Level: ModifyTemplates
27 28 29 30 |
# File 'lib/ElasticEmail/api/templates_api.rb', line 27 def templates_by_name_delete(name, opts = {}) templates_by_name_delete_with_http_info(name, opts) nil end |
#templates_by_name_delete_with_http_info(name, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Template Delete template with the specified name. Required Access Level: ModifyTemplates
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 |
# File 'lib/ElasticEmail/api/templates_api.rb', line 37 def templates_by_name_delete_with_http_info(name, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TemplatesApi.templates_by_name_delete ...' end # verify the required parameter 'name' is set if @api_client.config.client_side_validation && name.nil? fail ArgumentError, "Missing the required parameter 'name' when calling TemplatesApi.templates_by_name_delete" end # resource path local_var_path = '/templates/{name}'.sub('{' + 'name' + '}', CGI.escape(name.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[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['apikey'] = opts.merge( :operation => :"TemplatesApi.templates_by_name_delete", :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(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#templates_by_name_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#templates_by_name_get(name, opts = {}) ⇒ Template
Load Template Load detailed information of the specified template. Required Access Level: ViewTemplates
88 89 90 91 |
# File 'lib/ElasticEmail/api/templates_api.rb', line 88 def templates_by_name_get(name, opts = {}) data, _status_code, _headers = templates_by_name_get_with_http_info(name, opts) data end |
#templates_by_name_get_with_http_info(name, opts = {}) ⇒ Array<(Template, Integer, Hash)>
Load Template Load detailed information of the specified template. Required Access Level: ViewTemplates
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 141 142 143 144 |
# File 'lib/ElasticEmail/api/templates_api.rb', line 98 def templates_by_name_get_with_http_info(name, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TemplatesApi.templates_by_name_get ...' end # verify the required parameter 'name' is set if @api_client.config.client_side_validation && name.nil? fail ArgumentError, "Missing the required parameter 'name' when calling TemplatesApi.templates_by_name_get" end # resource path local_var_path = '/templates/{name}'.sub('{' + 'name' + '}', CGI.escape(name.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[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Template' # auth_names auth_names = opts[:debug_auth_names] || ['apikey'] = opts.merge( :operation => :"TemplatesApi.templates_by_name_get", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#templates_by_name_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#templates_by_name_put(name, template_payload, opts = {}) ⇒ Template
Update Template Update existing template, overwriting existing data. Required Access Level: ModifyTemplates
152 153 154 155 |
# File 'lib/ElasticEmail/api/templates_api.rb', line 152 def templates_by_name_put(name, template_payload, opts = {}) data, _status_code, _headers = templates_by_name_put_with_http_info(name, template_payload, opts) data end |
#templates_by_name_put_with_http_info(name, template_payload, opts = {}) ⇒ Array<(Template, Integer, Hash)>
Update Template Update existing template, overwriting existing data. Required Access Level: ModifyTemplates
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 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 |
# File 'lib/ElasticEmail/api/templates_api.rb', line 163 def templates_by_name_put_with_http_info(name, template_payload, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TemplatesApi.templates_by_name_put ...' end # verify the required parameter 'name' is set if @api_client.config.client_side_validation && name.nil? fail ArgumentError, "Missing the required parameter 'name' when calling TemplatesApi.templates_by_name_put" end # verify the required parameter 'template_payload' is set if @api_client.config.client_side_validation && template_payload.nil? fail ArgumentError, "Missing the required parameter 'template_payload' when calling TemplatesApi.templates_by_name_put" end # resource path local_var_path = '/templates/{name}'.sub('{' + 'name' + '}', CGI.escape(name.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' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(template_payload) # return_type return_type = opts[:debug_return_type] || 'Template' # auth_names auth_names = opts[:debug_auth_names] || ['apikey'] = opts.merge( :operation => :"TemplatesApi.templates_by_name_put", :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(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#templates_by_name_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#templates_get(scope_type, opts = {}) ⇒ Array<Template>
Load Templates Returns a list of templates for the specified type. Required Access Level: ViewTemplates
228 229 230 231 |
# File 'lib/ElasticEmail/api/templates_api.rb', line 228 def templates_get(scope_type, opts = {}) data, _status_code, _headers = templates_get_with_http_info(scope_type, opts) data end |
#templates_get_with_http_info(scope_type, opts = {}) ⇒ Array<(Array<Template>, Integer, Hash)>
Load Templates Returns a list of templates for the specified type. Required Access Level: ViewTemplates
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 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 |
# File 'lib/ElasticEmail/api/templates_api.rb', line 241 def templates_get_with_http_info(scope_type, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TemplatesApi.templates_get ...' end # verify the required parameter 'scope_type' is set if @api_client.config.client_side_validation && scope_type.nil? fail ArgumentError, "Missing the required parameter 'scope_type' when calling TemplatesApi.templates_get" end # resource path local_var_path = '/templates' # query parameters query_params = opts[:query_params] || {} query_params[:'scopeType'] = @api_client.build_collection_param(scope_type, :multi) query_params[:'templateTypes'] = @api_client.build_collection_param(opts[:'template_types'], :multi) if !opts[:'template_types'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Array<Template>' # auth_names auth_names = opts[:debug_auth_names] || ['apikey'] = opts.merge( :operation => :"TemplatesApi.templates_get", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#templates_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#templates_post(template_payload, opts = {}) ⇒ Template
Add Template Add a new Template. Required Access Level: ModifyTemplates
298 299 300 301 |
# File 'lib/ElasticEmail/api/templates_api.rb', line 298 def templates_post(template_payload, opts = {}) data, _status_code, _headers = templates_post_with_http_info(template_payload, opts) data end |
#templates_post_with_http_info(template_payload, opts = {}) ⇒ Array<(Template, Integer, Hash)>
Add Template Add a new Template. Required Access Level: ModifyTemplates
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 |
# File 'lib/ElasticEmail/api/templates_api.rb', line 308 def templates_post_with_http_info(template_payload, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TemplatesApi.templates_post ...' end # verify the required parameter 'template_payload' is set if @api_client.config.client_side_validation && template_payload.nil? fail ArgumentError, "Missing the required parameter 'template_payload' when calling TemplatesApi.templates_post" end # resource path local_var_path = '/templates' # 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' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(template_payload) # return_type return_type = opts[:debug_return_type] || 'Template' # auth_names auth_names = opts[:debug_auth_names] || ['apikey'] = opts.merge( :operation => :"TemplatesApi.templates_post", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#templates_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |