Class: ClickSendClient::TransactionalEmailApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TransactionalEmailApi

Returns a new instance of TransactionalEmailApi.



19
20
21
 
# File 'lib/clicksend_client/api/transactional_email_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/transactional_email_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#email_history_export_get(filename, opts = {}) ⇒ String

Export all Transactional Email history Export all Transactional Email history

Parameters:

  • filename —

    Filename to download history as

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

    the optional parameters

Options Hash (opts):

  • :date_from (Integer) —

    Start date

  • :date_to (Integer) —

    End date

Returns:

  • (String) 


29
30
31
32
 
# File 'lib/clicksend_client/api/transactional_email_api.rb', line 29

def email_history_export_get(filename, opts = {})
  data, _status_code, _headers = email_history_export_get_with_http_info(filename, opts)
  data
end

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

Export all Transactional Email history Export all Transactional Email history

Parameters:

  • filename —

    Filename to download history as

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

    the optional parameters

Options Hash (opts):

  • :date_from (Integer) —

    Start date

  • :date_to (Integer) —

    End date

Returns:

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

    String data, response status code and response headers



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/clicksend_client/api/transactional_email_api.rb', line 41

def email_history_export_get_with_http_info(filename, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalEmailApi.email_history_export_get ...'
  end
  # verify the required parameter 'filename' is set
  if @api_client.config.client_side_validation && filename.nil?
    fail ArgumentError, "Missing the required parameter 'filename' when calling TransactionalEmailApi.email_history_export_get"
  end
  # resource path
  local_var_path = '/email/history/export'

  # query parameters
  query_params = {}
  query_params[:'filename'] = filename
  query_params[:'date_from'] = opts[:'date_from'] if !opts[:'date_from'].nil?
  query_params[:'date_to'] = opts[:'date_to'] if !opts[:'date_to'].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: TransactionalEmailApi#email_history_export_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#email_history_get(opts = {}) ⇒ String

Get all transactional email history Get all transactional email history

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :date_from (Integer) —

    Start date

  • :date_to (Integer) —

    End date

  • :page (Integer) —

    Page number (default to 1)

  • :limit (Integer) —

    Number of records per page (default to 10)

Returns:

  • (String) 


91
92
93
94
 
# File 'lib/clicksend_client/api/transactional_email_api.rb', line 91

def email_history_get(opts = {})
  data, _status_code, _headers = email_history_get_with_http_info(opts)
  data
end

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

Get all transactional email history Get all transactional email history

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :date_from (Integer) —

    Start date

  • :date_to (Integer) —

    End date

  • :page (Integer) —

    Page number

  • :limit (Integer) —

    Number of records per page

Returns:

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

    String data, response status code and response headers



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

def email_history_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalEmailApi.email_history_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling TransactionalEmailApi.email_history_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 TransactionalEmailApi.email_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/email/history'

  # query parameters
  query_params = {}
  query_params[:'date_from'] = opts[:'date_from'] if !opts[:'date_from'].nil?
  query_params[:'date_to'] = opts[:'date_to'] if !opts[:'date_to'].nil?
  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: TransactionalEmailApi#email_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#email_price_post(email, opts = {}) ⇒ String

Get transactional email price Get transactional email price

Parameters:

  • email —

    Email model

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

    the optional parameters

Returns:

  • (String) 


156
157
158
159
 
# File 'lib/clicksend_client/api/transactional_email_api.rb', line 156

def email_price_post(email, opts = {})
  data, _status_code, _headers = email_price_post_with_http_info(email, opts)
  data
end

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

Get transactional email price Get transactional email price

Parameters:

  • email —

    Email model

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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

def email_price_post_with_http_info(email, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalEmailApi.email_price_post ...'
  end
  # verify the required parameter 'email' is set
  if @api_client.config.client_side_validation && email.nil?
    fail ArgumentError, "Missing the required parameter 'email' when calling TransactionalEmailApi.email_price_post"
  end
  # resource path
  local_var_path = '/email/price'

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

#email_send_post(email, opts = {}) ⇒ String

Send transactional email Send transactional email

Parameters:

  • email —

    Email model

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

    the optional parameters

Returns:

  • (String) 


210
211
212
213
 
# File 'lib/clicksend_client/api/transactional_email_api.rb', line 210

def email_send_post(email, opts = {})
  data, _status_code, _headers = email_send_post_with_http_info(email, opts)
  data
end

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

Send transactional email Send transactional email

Parameters:

  • email —

    Email model

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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

def email_send_post_with_http_info(email, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalEmailApi.email_send_post ...'
  end
  # verify the required parameter 'email' is set
  if @api_client.config.client_side_validation && email.nil?
    fail ArgumentError, "Missing the required parameter 'email' when calling TransactionalEmailApi.email_send_post"
  end
  # resource path
  local_var_path = '/email/send'

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