Class: ElasticEmail::EmailsApi
- Inherits:
-
Object
- Object
- ElasticEmail::EmailsApi
- Defined in:
- lib/ElasticEmail/api/emails_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#emails_by_msgid_view_get(msgid, opts = {}) ⇒ EmailData
View Email Returns email details for viewing or rendering.
-
#emails_by_msgid_view_get_with_http_info(msgid, opts = {}) ⇒ Array<(EmailData, Integer, Hash)>
View Email Returns email details for viewing or rendering.
-
#emails_mergefile_post(merge_email_payload, opts = {}) ⇒ EmailSend
Send Bulk Emails CSV Send bulk merge email.
-
#emails_mergefile_post_with_http_info(merge_email_payload, opts = {}) ⇒ Array<(EmailSend, Integer, Hash)>
Send Bulk Emails CSV Send bulk merge email.
-
#emails_post(email_message_data, opts = {}) ⇒ EmailSend
Send Bulk Emails Send bulk merge email.
-
#emails_post_with_http_info(email_message_data, opts = {}) ⇒ Array<(EmailSend, Integer, Hash)>
Send Bulk Emails Send bulk merge email.
-
#emails_transactional_post(email_transactional_message_data, opts = {}) ⇒ EmailSend
Send Transactional Email Send transactional emails (recipients will be known to each other).
-
#emails_transactional_post_with_http_info(email_transactional_message_data, opts = {}) ⇒ Array<(EmailSend, Integer, Hash)>
Send Transactional Email Send transactional emails (recipients will be known to each other).
-
#initialize(api_client = ApiClient.default) ⇒ EmailsApi
constructor
A new instance of EmailsApi.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/ElasticEmail/api/emails_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#emails_by_msgid_view_get(msgid, opts = {}) ⇒ EmailData
View Email Returns email details for viewing or rendering. Required Access Level: None
27 28 29 30 |
# File 'lib/ElasticEmail/api/emails_api.rb', line 27 def emails_by_msgid_view_get(msgid, opts = {}) data, _status_code, _headers = emails_by_msgid_view_get_with_http_info(msgid, opts) data end |
#emails_by_msgid_view_get_with_http_info(msgid, opts = {}) ⇒ Array<(EmailData, Integer, Hash)>
View Email Returns email details for viewing or rendering. Required Access Level: None
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 |
# File 'lib/ElasticEmail/api/emails_api.rb', line 37 def emails_by_msgid_view_get_with_http_info(msgid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: EmailsApi.emails_by_msgid_view_get ...' end # verify the required parameter 'msgid' is set if @api_client.config.client_side_validation && msgid.nil? fail ArgumentError, "Missing the required parameter 'msgid' when calling EmailsApi.emails_by_msgid_view_get" end # resource path local_var_path = '/emails/{msgid}/view'.sub('{' + 'msgid' + '}', CGI.escape(msgid.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] || 'EmailData' # auth_names auth_names = opts[:debug_auth_names] || ['apikey'] = opts.merge( :operation => :"EmailsApi.emails_by_msgid_view_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: EmailsApi#emails_by_msgid_view_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#emails_mergefile_post(merge_email_payload, opts = {}) ⇒ EmailSend
Send Bulk Emails CSV Send bulk merge email. Required Access Level: SendHttp
90 91 92 93 |
# File 'lib/ElasticEmail/api/emails_api.rb', line 90 def emails_mergefile_post(merge_email_payload, opts = {}) data, _status_code, _headers = emails_mergefile_post_with_http_info(merge_email_payload, opts) data end |
#emails_mergefile_post_with_http_info(merge_email_payload, opts = {}) ⇒ Array<(EmailSend, Integer, Hash)>
Send Bulk Emails CSV Send bulk merge email. Required Access Level: SendHttp
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 145 146 147 148 149 150 151 |
# File 'lib/ElasticEmail/api/emails_api.rb', line 100 def emails_mergefile_post_with_http_info(merge_email_payload, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: EmailsApi.emails_mergefile_post ...' end # verify the required parameter 'merge_email_payload' is set if @api_client.config.client_side_validation && merge_email_payload.nil? fail ArgumentError, "Missing the required parameter 'merge_email_payload' when calling EmailsApi.emails_mergefile_post" end # resource path local_var_path = '/emails/mergefile' # 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(merge_email_payload) # return_type return_type = opts[:debug_return_type] || 'EmailSend' # auth_names auth_names = opts[:debug_auth_names] || ['apikey'] = opts.merge( :operation => :"EmailsApi.emails_mergefile_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: EmailsApi#emails_mergefile_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#emails_post(email_message_data, opts = {}) ⇒ EmailSend
Send Bulk Emails Send bulk merge email. Required Access Level: SendHttp
158 159 160 161 |
# File 'lib/ElasticEmail/api/emails_api.rb', line 158 def emails_post(, opts = {}) data, _status_code, _headers = emails_post_with_http_info(, opts) data end |
#emails_post_with_http_info(email_message_data, opts = {}) ⇒ Array<(EmailSend, Integer, Hash)>
Send Bulk Emails Send bulk merge email. Required Access Level: SendHttp
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 219 |
# File 'lib/ElasticEmail/api/emails_api.rb', line 168 def emails_post_with_http_info(, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: EmailsApi.emails_post ...' end # verify the required parameter 'email_message_data' is set if @api_client.config.client_side_validation && .nil? fail ArgumentError, "Missing the required parameter 'email_message_data' when calling EmailsApi.emails_post" end # resource path local_var_path = '/emails' # 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() # return_type return_type = opts[:debug_return_type] || 'EmailSend' # auth_names auth_names = opts[:debug_auth_names] || ['apikey'] = opts.merge( :operation => :"EmailsApi.emails_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: EmailsApi#emails_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#emails_transactional_post(email_transactional_message_data, opts = {}) ⇒ EmailSend
Send Transactional Email Send transactional emails (recipients will be known to each other). Required Access Level: SendHttp
226 227 228 229 |
# File 'lib/ElasticEmail/api/emails_api.rb', line 226 def emails_transactional_post(, opts = {}) data, _status_code, _headers = emails_transactional_post_with_http_info(, opts) data end |
#emails_transactional_post_with_http_info(email_transactional_message_data, opts = {}) ⇒ Array<(EmailSend, Integer, Hash)>
Send Transactional Email Send transactional emails (recipients will be known to each other). Required Access Level: SendHttp
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 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 |
# File 'lib/ElasticEmail/api/emails_api.rb', line 236 def emails_transactional_post_with_http_info(, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: EmailsApi.emails_transactional_post ...' end # verify the required parameter 'email_transactional_message_data' is set if @api_client.config.client_side_validation && .nil? fail ArgumentError, "Missing the required parameter 'email_transactional_message_data' when calling EmailsApi.emails_transactional_post" end # resource path local_var_path = '/emails/transactional' # 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() # return_type return_type = opts[:debug_return_type] || 'EmailSend' # auth_names auth_names = opts[:debug_auth_names] || ['apikey'] = opts.merge( :operation => :"EmailsApi.emails_transactional_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: EmailsApi#emails_transactional_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |