Class: ElasticEmail::SubAccountsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ElasticEmail/api/sub_accounts_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SubAccountsApi

Returns a new instance of SubAccountsApi.



19
20
21
 
# File 'lib/ElasticEmail/api/sub_accounts_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/sub_accounts_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#subaccounts_by_email_credits_patch(email, subaccount_email_credits_payload, opts = {}) ⇒ nil

Add, Subtract Email Credits Update email credits of a subaccount by the given amount. Required Access Level: ModifySubAccounts

Parameters:

  • email (String) —

    Email address of Sub-Account

  • subaccount_email_credits_payload (SubaccountEmailCreditsPayload) —

    Amount of email credits to add or subtract from the current SubAccount email credits pool (positive or negative value)

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

    the optional parameters

Returns:

  • (nil) 


28
29
30
31
 
# File 'lib/ElasticEmail/api/sub_accounts_api.rb', line 28

def subaccounts_by_email_credits_patch(email, subaccount_email_credits_payload, opts = {})
  subaccounts_by_email_credits_patch_with_http_info(email, subaccount_email_credits_payload, opts)
  nil
end

#subaccounts_by_email_credits_patch_with_http_info(email, subaccount_email_credits_payload, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Add, Subtract Email Credits Update email credits of a subaccount by the given amount. Required Access Level: ModifySubAccounts

Parameters:

  • email (String) —

    Email address of Sub-Account

  • subaccount_email_credits_payload (SubaccountEmailCreditsPayload) —

    Amount of email credits to add or subtract from the current SubAccount email credits pool (positive or negative value)

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

    the optional parameters

Returns:

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

    nil, 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
84
85
86
87
88
89
90
91
92
 
# File 'lib/ElasticEmail/api/sub_accounts_api.rb', line 39

def subaccounts_by_email_credits_patch_with_http_info(email, subaccount_email_credits_payload, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubAccountsApi.subaccounts_by_email_credits_patch ...'
  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 SubAccountsApi.subaccounts_by_email_credits_patch"
  end
  # verify the required parameter 'subaccount_email_credits_payload' is set
  if @api_client.config.client_side_validation && subaccount_email_credits_payload.nil?
    fail ArgumentError, "Missing the required parameter 'subaccount_email_credits_payload' when calling SubAccountsApi.subaccounts_by_email_credits_patch"
  end
  # resource path
  local_var_path = '/subaccounts/{email}/credits'.sub('{' + 'email' + '}', CGI.escape(email.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(subaccount_email_credits_payload)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apikey']

  new_options = opts.merge(
    :operation => :"SubAccountsApi.subaccounts_by_email_credits_patch",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubAccountsApi#subaccounts_by_email_credits_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#subaccounts_by_email_delete(email, opts = {}) ⇒ nil

Delete SubAccount Deletes specified SubAccount. An email will be sent to confirm this change. Required Access Level: ModifySubAccounts

Parameters:

  • email (String) —

    Email address of Sub-Account

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

    the optional parameters

Returns:

  • (nil) 


99
100
101
102
 
# File 'lib/ElasticEmail/api/sub_accounts_api.rb', line 99

def subaccounts_by_email_delete(email, opts = {})
  subaccounts_by_email_delete_with_http_info(email, opts)
  nil
end

#subaccounts_by_email_delete_with_http_info(email, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete SubAccount Deletes specified SubAccount. An email will be sent to confirm this change. Required Access Level: ModifySubAccounts

Parameters:

  • email (String) —

    Email address of Sub-Account

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
152
153
 
# File 'lib/ElasticEmail/api/sub_accounts_api.rb', line 109

def subaccounts_by_email_delete_with_http_info(email, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubAccountsApi.subaccounts_by_email_delete ...'
  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 SubAccountsApi.subaccounts_by_email_delete"
  end
  # resource path
  local_var_path = '/subaccounts/{email}'.sub('{' + 'email' + '}', CGI.escape(email.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']

  new_options = opts.merge(
    :operation => :"SubAccountsApi.subaccounts_by_email_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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubAccountsApi#subaccounts_by_email_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#subaccounts_by_email_get(email, opts = {}) ⇒ SubAccountInfo

Load SubAccount Returns details for the specified SubAccount. Required Access Level: ViewSubAccounts

Parameters:

  • email (String) —

    Email address of Sub-Account

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

    the optional parameters

Returns:



160
161
162
163
 
# File 'lib/ElasticEmail/api/sub_accounts_api.rb', line 160

def subaccounts_by_email_get(email, opts = {})
  data, _status_code, _headers = subaccounts_by_email_get_with_http_info(email, opts)
  data
end

#subaccounts_by_email_get_with_http_info(email, opts = {}) ⇒ Array<(SubAccountInfo, Integer, Hash)>

Load SubAccount Returns details for the specified SubAccount. Required Access Level: ViewSubAccounts

Parameters:

  • email (String) —

    Email address of Sub-Account

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

    the optional parameters

Returns:

  • (Array<(SubAccountInfo, Integer, Hash)>) —

    SubAccountInfo data, response status code and response headers



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
 
# File 'lib/ElasticEmail/api/sub_accounts_api.rb', line 170

def subaccounts_by_email_get_with_http_info(email, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubAccountsApi.subaccounts_by_email_get ...'
  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 SubAccountsApi.subaccounts_by_email_get"
  end
  # resource path
  local_var_path = '/subaccounts/{email}'.sub('{' + 'email' + '}', CGI.escape(email.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] || 'SubAccountInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apikey']

  new_options = opts.merge(
    :operation => :"SubAccountsApi.subaccounts_by_email_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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubAccountsApi#subaccounts_by_email_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#subaccounts_by_email_settings_email_put(email, subaccount_email_settings, opts = {}) ⇒ SubaccountEmailSettings

Update SubAccount Email Settings Update SubAccount email settings. Required Access Level: ModifySubAccounts

Parameters:

  • email (String)
  • subaccount_email_settings (SubaccountEmailSettings) —

    Updated Email Settings

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

    the optional parameters

Returns:



224
225
226
227
 
# File 'lib/ElasticEmail/api/sub_accounts_api.rb', line 224

def subaccounts_by_email_settings_email_put(email, subaccount_email_settings, opts = {})
  data, _status_code, _headers = subaccounts_by_email_settings_email_put_with_http_info(email, subaccount_email_settings, opts)
  data
end

#subaccounts_by_email_settings_email_put_with_http_info(email, subaccount_email_settings, opts = {}) ⇒ Array<(SubaccountEmailSettings, Integer, Hash)>

Update SubAccount Email Settings Update SubAccount email settings. Required Access Level: ModifySubAccounts

Parameters:

  • email (String)
  • subaccount_email_settings (SubaccountEmailSettings) —

    Updated Email Settings

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

    the optional parameters

Returns:

  • (Array<(SubaccountEmailSettings, Integer, Hash)>) —

    SubaccountEmailSettings data, response status code and response headers



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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/ElasticEmail/api/sub_accounts_api.rb', line 235

def subaccounts_by_email_settings_email_put_with_http_info(email, subaccount_email_settings, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubAccountsApi.subaccounts_by_email_settings_email_put ...'
  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 SubAccountsApi.subaccounts_by_email_settings_email_put"
  end
  # verify the required parameter 'subaccount_email_settings' is set
  if @api_client.config.client_side_validation && subaccount_email_settings.nil?
    fail ArgumentError, "Missing the required parameter 'subaccount_email_settings' when calling SubAccountsApi.subaccounts_by_email_settings_email_put"
  end
  # resource path
  local_var_path = '/subaccounts/{email}/settings/email'.sub('{' + 'email' + '}', CGI.escape(email.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(subaccount_email_settings)

  # return_type
  return_type = opts[:debug_return_type] || 'SubaccountEmailSettings'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apikey']

  new_options = opts.merge(
    :operation => :"SubAccountsApi.subaccounts_by_email_settings_email_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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubAccountsApi#subaccounts_by_email_settings_email_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#subaccounts_get(opts = {}) ⇒ Array<SubAccountInfo>

Load SubAccounts Returns a list of all your SubAccounts. Required Access Level: ViewSubAccounts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Maximum number of returned items.

  • :offset (Integer) —

    How many items should be returned ahead.

Returns:



298
299
300
301
 
# File 'lib/ElasticEmail/api/sub_accounts_api.rb', line 298

def subaccounts_get(opts = {})
  data, _status_code, _headers = subaccounts_get_with_http_info(opts)
  data
end

#subaccounts_get_with_http_info(opts = {}) ⇒ Array<(Array<SubAccountInfo>, Integer, Hash)>

Load SubAccounts Returns a list of all your SubAccounts. Required Access Level: ViewSubAccounts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Maximum number of returned items.

  • :offset (Integer) —

    How many items should be returned ahead.

Returns:

  • (Array<(Array<SubAccountInfo>, Integer, Hash)>) —

    Array<SubAccountInfo> data, response status code and response headers



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
 
# File 'lib/ElasticEmail/api/sub_accounts_api.rb', line 309

def subaccounts_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubAccountsApi.subaccounts_get ...'
  end
  # resource path
  local_var_path = '/subaccounts'

  # query parameters
  query_params = opts[:query_params] || {}
  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<SubAccountInfo>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apikey']

  new_options = opts.merge(
    :operation => :"SubAccountsApi.subaccounts_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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubAccountsApi#subaccounts_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#subaccounts_post(subaccount_payload, opts = {}) ⇒ SubAccountInfo

Add SubAccount Add a new SubAccount to your Account. To receive an access token for this SubAccount, make a POST security/apikeys request using the 'subaccount' parameter. Required Access Level: ModifySubAccounts

Parameters:

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

    the optional parameters

Returns:



360
361
362
363
 
# File 'lib/ElasticEmail/api/sub_accounts_api.rb', line 360

def subaccounts_post(subaccount_payload, opts = {})
  data, _status_code, _headers = subaccounts_post_with_http_info(subaccount_payload, opts)
  data
end

#subaccounts_post_with_http_info(subaccount_payload, opts = {}) ⇒ Array<(SubAccountInfo, Integer, Hash)>

Add SubAccount Add a new SubAccount to your Account. To receive an access token for this SubAccount, make a POST security/apikeys request using the &#39;subaccount&#39; parameter. Required Access Level: ModifySubAccounts

Parameters:

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

    the optional parameters

Returns:

  • (Array<(SubAccountInfo, Integer, Hash)>) —

    SubAccountInfo data, response status code and response headers



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/ElasticEmail/api/sub_accounts_api.rb', line 370

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

  # 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(subaccount_payload)

  # return_type
  return_type = opts[:debug_return_type] || 'SubAccountInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apikey']

  new_options = opts.merge(
    :operation => :"SubAccountsApi.subaccounts_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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubAccountsApi#subaccounts_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end