Class: SibApiV3Sdk::ResellerApi

Inherits:
Object
  • Object
show all
Defined in:
lib/sib-api-v3-sdk/api/reseller_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ResellerApi

Returns a new instance of ResellerApi.



19
20
21
 
# File 'lib/sib-api-v3-sdk/api/reseller_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/sib-api-v3-sdk/api/reseller_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_credits(child_auth_key, add_credits, opts = {}) ⇒ RemainingCreditModel

Add Email and/or SMS credits to a specific child account

Parameters:

  • child_auth_key —

    auth key of reseller's child

  • add_credits —

    Values to post to add credit to a specific child account

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

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 29

def add_credits(child_auth_key, add_credits, opts = {})
  data, _status_code, _headers = add_credits_with_http_info(child_auth_key, add_credits, opts)
  return data
end

#add_credits_with_http_info(child_auth_key, add_credits, opts = {}) ⇒ Array<(RemainingCreditModel, Fixnum, Hash)>

Add Email and/or SMS credits to a specific child account

Parameters:

  • child_auth_key —

    auth key of reseller&#39;s child

  • add_credits —

    Values to post to add credit to a specific child account

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

    the optional parameters

Returns:

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

    RemainingCreditModel data, response status code and response headers



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
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 40

def add_credits_with_http_info(child_auth_key, add_credits, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResellerApi.add_credits ..."
  end
  # verify the required parameter 'child_auth_key' is set
  if @api_client.config.client_side_validation && child_auth_key.nil?
    fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.add_credits"
  end
  # verify the required parameter 'add_credits' is set
  if @api_client.config.client_side_validation && add_credits.nil?
    fail ArgumentError, "Missing the required parameter 'add_credits' when calling ResellerApi.add_credits"
  end
  # resource path
  local_var_path = "/reseller/children/{childAuthKey}/credits/add".sub('{' + 'childAuthKey' + '}', child_auth_key.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 = @api_client.object_to_http_body(add_credits)
  auth_names = ['api-key', 'partner-key']
  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 => 'RemainingCreditModel')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResellerApi#add_credits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#associate_ip_to_child(child_auth_key, ip, opts = {}) ⇒ nil

Associate a dedicated IP to the child

Parameters:

  • child_auth_key —

    auth key of reseller&#39;s child

  • ip —

    IP to associate

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

    the optional parameters

Returns:

  • (nil) 


90
91
92
93
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 90

def associate_ip_to_child(child_auth_key, ip, opts = {})
  associate_ip_to_child_with_http_info(child_auth_key, ip, opts)
  return nil
end

#associate_ip_to_child_with_http_info(child_auth_key, ip, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Associate a dedicated IP to the child

Parameters:

  • child_auth_key —

    auth key of reseller&#39;s child

  • ip —

    IP to associate

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 101

def associate_ip_to_child_with_http_info(child_auth_key, ip, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResellerApi.associate_ip_to_child ..."
  end
  # verify the required parameter 'child_auth_key' is set
  if @api_client.config.client_side_validation && child_auth_key.nil?
    fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.associate_ip_to_child"
  end
  # verify the required parameter 'ip' is set
  if @api_client.config.client_side_validation && ip.nil?
    fail ArgumentError, "Missing the required parameter 'ip' when calling ResellerApi.associate_ip_to_child"
  end
  # resource path
  local_var_path = "/reseller/children/{childAuthKey}/ips/associate".sub('{' + 'childAuthKey' + '}', child_auth_key.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 = @api_client.object_to_http_body(ip)
  auth_names = ['api-key', 'partner-key']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResellerApi#associate_ip_to_child\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_child_domain(child_auth_key, add_child_domain, opts = {}) ⇒ nil

Creates a domain for a child account

Parameters:

  • child_auth_key —

    auth key of reseller&#39;s child

  • add_child_domain —

    Sender domain to add for a specific child account

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

    the optional parameters

Returns:

  • (nil) 


150
151
152
153
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 150

def create_child_domain(child_auth_key, add_child_domain, opts = {})
  create_child_domain_with_http_info(child_auth_key, add_child_domain, opts)
  return nil
end

#create_child_domain_with_http_info(child_auth_key, add_child_domain, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Creates a domain for a child account

Parameters:

  • child_auth_key —

    auth key of reseller&#39;s child

  • add_child_domain —

    Sender domain to add for a specific child account

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 161

def create_child_domain_with_http_info(child_auth_key, add_child_domain, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResellerApi.create_child_domain ..."
  end
  # verify the required parameter 'child_auth_key' is set
  if @api_client.config.client_side_validation && child_auth_key.nil?
    fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.create_child_domain"
  end
  # verify the required parameter 'add_child_domain' is set
  if @api_client.config.client_side_validation && add_child_domain.nil?
    fail ArgumentError, "Missing the required parameter 'add_child_domain' when calling ResellerApi.create_child_domain"
  end
  # resource path
  local_var_path = "/reseller/children/{childAuthKey}/domains".sub('{' + 'childAuthKey' + '}', child_auth_key.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 = @api_client.object_to_http_body(add_child_domain)
  auth_names = ['api-key', 'partner-key']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResellerApi#create_child_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_reseller_child(opts = {}) ⇒ CreateReseller

Creates a reseller child

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :reseller_child (CreateChild) —

    reseller child to add

Returns:



209
210
211
212
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 209

def create_reseller_child(opts = {})
  data, _status_code, _headers = create_reseller_child_with_http_info(opts)
  return data
end

#create_reseller_child_with_http_info(opts = {}) ⇒ Array<(CreateReseller, Fixnum, Hash)>

Creates a reseller child

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :reseller_child (CreateChild) —

    reseller child to add

Returns:

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

    CreateReseller data, response status code and response headers



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/sib-api-v3-sdk/api/reseller_api.rb', line 219

def create_reseller_child_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResellerApi.create_reseller_child ..."
  end
  # resource path
  local_var_path = "/reseller/children"

  # 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(opts[:'reseller_child'])
  auth_names = ['api-key', 'partner-key']
  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 => 'CreateReseller')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResellerApi#create_reseller_child\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_child_domain(child_auth_key, domain_name, opts = {}) ⇒ nil

Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed

Parameters:

  • child_auth_key —

    auth key of reseller&#39;s child

  • domain_name —

    Pass the existing domain that needs to be deleted

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

    the optional parameters

Returns:

  • (nil) 


261
262
263
264
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 261

def delete_child_domain(child_auth_key, domain_name, opts = {})
  delete_child_domain_with_http_info(child_auth_key, domain_name, opts)
  return nil
end

#delete_child_domain_with_http_info(child_auth_key, domain_name, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed

Parameters:

  • child_auth_key —

    auth key of reseller&#39;s child

  • domain_name —

    Pass the existing domain that needs to be deleted

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



272
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
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 272

def delete_child_domain_with_http_info(child_auth_key, domain_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResellerApi.delete_child_domain ..."
  end
  # verify the required parameter 'child_auth_key' is set
  if @api_client.config.client_side_validation && child_auth_key.nil?
    fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.delete_child_domain"
  end
  # verify the required parameter 'domain_name' is set
  if @api_client.config.client_side_validation && domain_name.nil?
    fail ArgumentError, "Missing the required parameter 'domain_name' when calling ResellerApi.delete_child_domain"
  end
  # resource path
  local_var_path = "/reseller/children/{childAuthKey}/domains/{domainName}".sub('{' + 'childAuthKey' + '}', child_auth_key.to_s).sub('{' + 'domainName' + '}', domain_name.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 = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResellerApi#delete_child_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_reseller_child(child_auth_key, opts = {}) ⇒ nil

Deletes a single reseller child based on the childAuthKey supplied

Parameters:

  • child_auth_key —

    auth key of reseller&#39;s child

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

    the optional parameters

Returns:

  • (nil) 


320
321
322
323
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 320

def delete_reseller_child(child_auth_key, opts = {})
  delete_reseller_child_with_http_info(child_auth_key, opts)
  return nil
end

#delete_reseller_child_with_http_info(child_auth_key, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Deletes a single reseller child based on the childAuthKey supplied

Parameters:

  • child_auth_key —

    auth key of reseller&#39;s child

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
360
361
362
363
364
365
366
367
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 330

def delete_reseller_child_with_http_info(child_auth_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResellerApi.delete_reseller_child ..."
  end
  # verify the required parameter 'child_auth_key' is set
  if @api_client.config.client_side_validation && child_auth_key.nil?
    fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.delete_reseller_child"
  end
  # resource path
  local_var_path = "/reseller/children/{childAuthKey}".sub('{' + 'childAuthKey' + '}', child_auth_key.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 = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResellerApi#delete_reseller_child\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#dissociate_ip_from_child(child_auth_key, ip, opts = {}) ⇒ nil

Dissociate a dedicated IP to the child

Parameters:

  • child_auth_key —

    auth key of reseller&#39;s child

  • ip —

    IP to dissociate

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

    the optional parameters

Returns:

  • (nil) 


375
376
377
378
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 375

def dissociate_ip_from_child(child_auth_key, ip, opts = {})
  dissociate_ip_from_child_with_http_info(child_auth_key, ip, opts)
  return nil
end

#dissociate_ip_from_child_with_http_info(child_auth_key, ip, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Dissociate a dedicated IP to the child

Parameters:

  • child_auth_key —

    auth key of reseller&#39;s child

  • ip —

    IP to dissociate

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
422
423
424
425
426
427
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 386

def dissociate_ip_from_child_with_http_info(child_auth_key, ip, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResellerApi.dissociate_ip_from_child ..."
  end
  # verify the required parameter 'child_auth_key' is set
  if @api_client.config.client_side_validation && child_auth_key.nil?
    fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.dissociate_ip_from_child"
  end
  # verify the required parameter 'ip' is set
  if @api_client.config.client_side_validation && ip.nil?
    fail ArgumentError, "Missing the required parameter 'ip' when calling ResellerApi.dissociate_ip_from_child"
  end
  # resource path
  local_var_path = "/reseller/children/{childAuthKey}/ips/dissociate".sub('{' + 'childAuthKey' + '}', child_auth_key.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 = @api_client.object_to_http_body(ip)
  auth_names = ['api-key', 'partner-key']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResellerApi#dissociate_ip_from_child\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_child_domains(child_auth_key, opts = {}) ⇒ GetChildDomains

Gets all the sender domains of a specific child account

Parameters:

  • child_auth_key —

    auth key of reseller&#39;s child

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

    the optional parameters

Returns:



434
435
436
437
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 434

def get_child_domains(child_auth_key, opts = {})
  data, _status_code, _headers = get_child_domains_with_http_info(child_auth_key, opts)
  return data
end

#get_child_domains_with_http_info(child_auth_key, opts = {}) ⇒ Array<(GetChildDomains, Fixnum, Hash)>

Gets all the sender domains of a specific child account

Parameters:

  • child_auth_key —

    auth key of reseller&#39;s child

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

    the optional parameters

Returns:

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

    GetChildDomains data, response status code and response headers



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 444

def get_child_domains_with_http_info(child_auth_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResellerApi.get_child_domains ..."
  end
  # verify the required parameter 'child_auth_key' is set
  if @api_client.config.client_side_validation && child_auth_key.nil?
    fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.get_child_domains"
  end
  # resource path
  local_var_path = "/reseller/children/{childAuthKey}/domains".sub('{' + 'childAuthKey' + '}', child_auth_key.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 = ['api-key', 'partner-key']
  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 => 'GetChildDomains')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResellerApi#get_child_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_child_info(child_auth_key, opts = {}) ⇒ GetChildInfo

Gets the info about a specific child account

Parameters:

  • child_auth_key —

    auth key of reseller&#39;s child

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

    the optional parameters

Returns:



489
490
491
492
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 489

def get_child_info(child_auth_key, opts = {})
  data, _status_code, _headers = get_child_info_with_http_info(child_auth_key, opts)
  return data
end

#get_child_info_with_http_info(child_auth_key, opts = {}) ⇒ Array<(GetChildInfo, Fixnum, Hash)>

Gets the info about a specific child account

Parameters:

  • child_auth_key —

    auth key of reseller&#39;s child

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

    the optional parameters

Returns:

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

    GetChildInfo data, response status code and response headers



499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 499

def get_child_info_with_http_info(child_auth_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResellerApi.get_child_info ..."
  end
  # verify the required parameter 'child_auth_key' is set
  if @api_client.config.client_side_validation && child_auth_key.nil?
    fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.get_child_info"
  end
  # resource path
  local_var_path = "/reseller/children/{childAuthKey}".sub('{' + 'childAuthKey' + '}', child_auth_key.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 = ['api-key', 'partner-key']
  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 => 'GetChildInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResellerApi#get_child_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_reseller_childs(opts = {}) ⇒ GetChildrenList

Gets the list of all reseller’s children accounts

Parameters:

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

    the optional parameters

Returns:



543
544
545
546
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 543

def get_reseller_childs(opts = {})
  data, _status_code, _headers = get_reseller_childs_with_http_info(opts)
  return data
end

#get_reseller_childs_with_http_info(opts = {}) ⇒ Array<(GetChildrenList, Fixnum, Hash)>

Gets the list of all reseller&#39;s children accounts

Parameters:

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

    the optional parameters

Returns:

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

    GetChildrenList data, response status code and response headers



552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 552

def get_reseller_childs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResellerApi.get_reseller_childs ..."
  end
  # resource path
  local_var_path = "/reseller/children"

  # 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 = ['api-key', 'partner-key']
  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 => 'GetChildrenList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResellerApi#get_reseller_childs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sso_token(child_auth_key, opts = {}) ⇒ GetSsoToken

Get session token to access Sendinblue (SSO) It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => email.mydomain.com/login/sso?token=[token]

Parameters:

  • child_auth_key —

    auth key of reseller&#39;s child

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

    the optional parameters

Returns:



593
594
595
596
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 593

def get_sso_token(child_auth_key, opts = {})
  data, _status_code, _headers = get_sso_token_with_http_info(child_auth_key, opts)
  return data
end

#get_sso_token_with_http_info(child_auth_key, opts = {}) ⇒ Array<(GetSsoToken, Fixnum, Hash)>

Get session token to access Sendinblue (SSO) It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern &#x3D;&gt; email.mydomain.com/login/sso?token&#x3D;[token]

Parameters:

  • child_auth_key —

    auth key of reseller&#39;s child

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

    the optional parameters

Returns:

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

    GetSsoToken data, response status code and response headers



603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 603

def get_sso_token_with_http_info(child_auth_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResellerApi.get_sso_token ..."
  end
  # verify the required parameter 'child_auth_key' is set
  if @api_client.config.client_side_validation && child_auth_key.nil?
    fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.get_sso_token"
  end
  # resource path
  local_var_path = "/reseller/children/{childAuthKey}/auth".sub('{' + 'childAuthKey' + '}', child_auth_key.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 = ['api-key', 'partner-key']
  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 => 'GetSsoToken')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResellerApi#get_sso_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_credits(child_auth_key, remove_credits, opts = {}) ⇒ RemainingCreditModel

Remove Email and/or SMS credits from a specific child account

Parameters:

  • child_auth_key —

    auth key of reseller&#39;s child

  • remove_credits —

    Values to post to remove email or SMS credits from a specific child account

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

    the optional parameters

Returns:



649
650
651
652
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 649

def remove_credits(child_auth_key, remove_credits, opts = {})
  data, _status_code, _headers = remove_credits_with_http_info(child_auth_key, remove_credits, opts)
  return data
end

#remove_credits_with_http_info(child_auth_key, remove_credits, opts = {}) ⇒ Array<(RemainingCreditModel, Fixnum, Hash)>

Remove Email and/or SMS credits from a specific child account

Parameters:

  • child_auth_key —

    auth key of reseller&#39;s child

  • remove_credits —

    Values to post to remove email or SMS credits from a specific child account

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

    the optional parameters

Returns:

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

    RemainingCreditModel data, response status code and response headers



660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 660

def remove_credits_with_http_info(child_auth_key, remove_credits, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResellerApi.remove_credits ..."
  end
  # verify the required parameter 'child_auth_key' is set
  if @api_client.config.client_side_validation && child_auth_key.nil?
    fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.remove_credits"
  end
  # verify the required parameter 'remove_credits' is set
  if @api_client.config.client_side_validation && remove_credits.nil?
    fail ArgumentError, "Missing the required parameter 'remove_credits' when calling ResellerApi.remove_credits"
  end
  # resource path
  local_var_path = "/reseller/children/{childAuthKey}/credits/remove".sub('{' + 'childAuthKey' + '}', child_auth_key.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 = @api_client.object_to_http_body(remove_credits)
  auth_names = ['api-key', 'partner-key']
  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 => 'RemainingCreditModel')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResellerApi#remove_credits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_child_account_status(child_auth_key, update_child_account_status, opts = {}) ⇒ nil

Updates infos of reseller’s child account status based on the childAuthKey supplied

Parameters:

  • child_auth_key —

    auth key of reseller&#39;s child

  • update_child_account_status —

    values to update in child account status

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

    the optional parameters

Returns:

  • (nil) 


710
711
712
713
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 710

def (child_auth_key, , opts = {})
  (child_auth_key, , opts)
  return nil
end

#update_child_account_status_with_http_info(child_auth_key, update_child_account_status, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Updates infos of reseller&#39;s child account status based on the childAuthKey supplied

Parameters:

  • child_auth_key —

    auth key of reseller&#39;s child

  • update_child_account_status —

    values to update in child account status

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 721

def (child_auth_key, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResellerApi.update_child_account_status ..."
  end
  # verify the required parameter 'child_auth_key' is set
  if @api_client.config.client_side_validation && child_auth_key.nil?
    fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.update_child_account_status"
  end
  # verify the required parameter 'update_child_account_status' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'update_child_account_status' when calling ResellerApi.update_child_account_status"
  end
  # resource path
  local_var_path = "/reseller/children/{childAuthKey}/accountStatus".sub('{' + 'childAuthKey' + '}', child_auth_key.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 = @api_client.object_to_http_body()
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResellerApi#update_child_account_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_child_domain(child_auth_key, domain_name, update_child_domain, opts = {}) ⇒ nil

Updates the sender domain of reseller’s child based on the childAuthKey and domainName passed

Parameters:

  • child_auth_key —

    auth key of reseller&#39;s child

  • domain_name —

    Pass the existing domain that needs to be updated

  • update_child_domain —

    value to update for sender domain

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

    the optional parameters

Returns:

  • (nil) 


771
772
773
774
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 771

def update_child_domain(child_auth_key, domain_name, update_child_domain, opts = {})
  update_child_domain_with_http_info(child_auth_key, domain_name, update_child_domain, opts)
  return nil
end

#update_child_domain_with_http_info(child_auth_key, domain_name, update_child_domain, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Updates the sender domain of reseller&#39;s child based on the childAuthKey and domainName passed

Parameters:

  • child_auth_key —

    auth key of reseller&#39;s child

  • domain_name —

    Pass the existing domain that needs to be updated

  • update_child_domain —

    value to update for sender domain

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 783

def update_child_domain_with_http_info(child_auth_key, domain_name, update_child_domain, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResellerApi.update_child_domain ..."
  end
  # verify the required parameter 'child_auth_key' is set
  if @api_client.config.client_side_validation && child_auth_key.nil?
    fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.update_child_domain"
  end
  # verify the required parameter 'domain_name' is set
  if @api_client.config.client_side_validation && domain_name.nil?
    fail ArgumentError, "Missing the required parameter 'domain_name' when calling ResellerApi.update_child_domain"
  end
  # verify the required parameter 'update_child_domain' is set
  if @api_client.config.client_side_validation && update_child_domain.nil?
    fail ArgumentError, "Missing the required parameter 'update_child_domain' when calling ResellerApi.update_child_domain"
  end
  # resource path
  local_var_path = "/reseller/children/{childAuthKey}/domains/{domainName}".sub('{' + 'childAuthKey' + '}', child_auth_key.to_s).sub('{' + 'domainName' + '}', domain_name.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 = @api_client.object_to_http_body(update_child_domain)
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResellerApi#update_child_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_reseller_child(child_auth_key, reseller_child, opts = {}) ⇒ nil

Updates infos of reseller’s child based on the childAuthKey supplied

Parameters:

  • child_auth_key —

    auth key of reseller&#39;s child

  • reseller_child —

    values to update in child profile

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

    the optional parameters

Returns:

  • (nil) 


836
837
838
839
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 836

def update_reseller_child(child_auth_key, reseller_child, opts = {})
  update_reseller_child_with_http_info(child_auth_key, reseller_child, opts)
  return nil
end

#update_reseller_child_with_http_info(child_auth_key, reseller_child, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Updates infos of reseller&#39;s child based on the childAuthKey supplied

Parameters:

  • child_auth_key —

    auth key of reseller&#39;s child

  • reseller_child —

    values to update in child profile

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
 
# File 'lib/sib-api-v3-sdk/api/reseller_api.rb', line 847

def update_reseller_child_with_http_info(child_auth_key, reseller_child, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResellerApi.update_reseller_child ..."
  end
  # verify the required parameter 'child_auth_key' is set
  if @api_client.config.client_side_validation && child_auth_key.nil?
    fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.update_reseller_child"
  end
  # verify the required parameter 'reseller_child' is set
  if @api_client.config.client_side_validation && reseller_child.nil?
    fail ArgumentError, "Missing the required parameter 'reseller_child' when calling ResellerApi.update_reseller_child"
  end
  # resource path
  local_var_path = "/reseller/children/{childAuthKey}".sub('{' + 'childAuthKey' + '}', child_auth_key.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 = @api_client.object_to_http_body(reseller_child)
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResellerApi#update_reseller_child\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end