sib-api-v3-sdk 5.4.0 → 7.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (99) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +42 -37
  3. data/docs/AbTestCampaignResult.md +2 -0
  4. data/docs/AbTestCampaignResultClickedLinks.md +9 -0
  5. data/docs/AbTestCampaignResultStatistics.md +13 -0
  6. data/docs/AbTestVersionClicks.md +7 -0
  7. data/docs/AbTestVersionClicksInner.md +10 -0
  8. data/docs/AbTestVersionStats.md +9 -0
  9. data/docs/AddContactToList.md +2 -1
  10. data/docs/ContactsApi.md +29 -29
  11. data/docs/CreateChild.md +1 -0
  12. data/docs/CreateDoiContact.md +2 -2
  13. data/docs/CreateReseller.md +1 -0
  14. data/docs/CreateSender.md +1 -1
  15. data/docs/CreateSmsCampaign.md +1 -1
  16. data/docs/CreateWebhook.md +1 -1
  17. data/docs/EmailExportRecipients.md +1 -1
  18. data/docs/GetAggregatedReport.md +13 -13
  19. data/docs/GetCampaignStats.md +1 -0
  20. data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +1 -1
  21. data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +1 -1
  22. data/docs/GetSmtpTemplateOverview.md +1 -0
  23. data/docs/ListsApi.md +4 -4
  24. data/docs/PostContactInfoContacts.md +1 -0
  25. data/docs/RemoveContactFromList.md +2 -1
  26. data/docs/RequestContactExport.md +1 -1
  27. data/docs/RequestContactImport.md +1 -1
  28. data/docs/RequestSMSRecipientExport.md +1 -1
  29. data/docs/ResellerApi.md +82 -82
  30. data/docs/SendReportEmail.md +1 -5
  31. data/docs/SendSmtpEmail.md +1 -1
  32. data/docs/SendSmtpEmailSender.md +1 -0
  33. data/docs/SendTransacSms.md +1 -1
  34. data/docs/{SMTPApi.md → TransactionalEmailsApi.md} +52 -52
  35. data/docs/TransactionalSMSApi.md +3 -3
  36. data/docs/UpdateChildAccountStatus.md +1 -0
  37. data/docs/UpdateSmsCampaign.md +1 -1
  38. data/docs/UpdateWebhook.md +1 -1
  39. data/lib/sib-api-v3-sdk.rb +6 -1
  40. data/lib/sib-api-v3-sdk/api/contacts_api.rb +44 -44
  41. data/lib/sib-api-v3-sdk/api/lists_api.rb +4 -4
  42. data/lib/sib-api-v3-sdk/api/reseller_api.rb +138 -138
  43. data/lib/sib-api-v3-sdk/api/{smtp_api.rb → transactional_emails_api.rb} +52 -52
  44. data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +2 -2
  45. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +22 -4
  46. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_clicked_links.rb +202 -0
  47. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_statistics.rb +258 -0
  48. data/lib/sib-api-v3-sdk/models/ab_test_version_clicks.rb +175 -0
  49. data/lib/sib-api-v3-sdk/models/ab_test_version_clicks_inner.rb +219 -0
  50. data/lib/sib-api-v3-sdk/models/ab_test_version_stats.rb +205 -0
  51. data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +17 -5
  52. data/lib/sib-api-v3-sdk/models/create_child.rb +48 -4
  53. data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +7 -2
  54. data/lib/sib-api-v3-sdk/models/create_reseller.rb +14 -4
  55. data/lib/sib-api-v3-sdk/models/create_sender.rb +1 -1
  56. data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +6 -6
  57. data/lib/sib-api-v3-sdk/models/create_webhook.rb +1 -1
  58. data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +1 -1
  59. data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +0 -65
  60. data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +14 -4
  61. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +0 -5
  62. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +0 -5
  63. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +14 -4
  64. data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +14 -4
  65. data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +14 -2
  66. data/lib/sib-api-v3-sdk/models/request_contact_export.rb +1 -1
  67. data/lib/sib-api-v3-sdk/models/request_contact_import.rb +1 -1
  68. data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +1 -1
  69. data/lib/sib-api-v3-sdk/models/send_report_email.rb +3 -88
  70. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +1 -1
  71. data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +15 -5
  72. data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +6 -6
  73. data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +14 -4
  74. data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +6 -6
  75. data/lib/sib-api-v3-sdk/models/update_webhook.rb +1 -1
  76. data/lib/sib-api-v3-sdk/version.rb +1 -1
  77. data/spec/api/contacts_api_spec.rb +8 -8
  78. data/spec/api/lists_api_spec.rb +2 -2
  79. data/spec/api/reseller_api_spec.rb +20 -20
  80. data/spec/api/{smtp_api_spec.rb → transactional_emails_api_spec.rb} +6 -6
  81. data/spec/api/transactional_sms_api_spec.rb +1 -1
  82. data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +47 -0
  83. data/spec/models/ab_test_campaign_result_spec.rb +12 -0
  84. data/spec/models/ab_test_campaign_result_statistics_spec.rb +71 -0
  85. data/spec/models/ab_test_version_clicks_inner_spec.rb +53 -0
  86. data/spec/models/ab_test_version_clicks_spec.rb +35 -0
  87. data/spec/models/ab_test_version_stats_spec.rb +47 -0
  88. data/spec/models/add_contact_to_list_spec.rb +6 -0
  89. data/spec/models/create_child_spec.rb +10 -0
  90. data/spec/models/create_reseller_spec.rb +6 -0
  91. data/spec/models/create_webhook_spec.rb +1 -1
  92. data/spec/models/get_campaign_stats_spec.rb +6 -0
  93. data/spec/models/get_smtp_template_overview_spec.rb +6 -0
  94. data/spec/models/post_contact_info_contacts_spec.rb +6 -0
  95. data/spec/models/remove_contact_from_list_spec.rb +6 -0
  96. data/spec/models/send_report_email_spec.rb +0 -28
  97. data/spec/models/send_smtp_email_sender_spec.rb +6 -0
  98. data/spec/models/update_child_account_status_spec.rb +6 -0
  99. metadata +30 -10
@@ -21,7 +21,7 @@ module SibApiV3Sdk
21
21
  end
22
22
  # Add existing contacts to a list
23
23
  # @param list_id Id of the list
24
- # @param contact_emails Emails addresses of the contacts
24
+ # @param contact_emails Emails addresses OR IDs of the contacts
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [PostContactInfo]
27
27
  def add_contact_to_list(list_id, contact_emails, opts = {})
@@ -31,7 +31,7 @@ module SibApiV3Sdk
31
31
 
32
32
  # Add existing contacts to a list
33
33
  # @param list_id Id of the list
34
- # @param contact_emails Emails addresses of the contacts
34
+ # @param contact_emails Emails addresses OR IDs of the contacts
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(PostContactInfo, Fixnum, Hash)>] PostContactInfo data, response status code and response headers
37
37
  def add_contact_to_list_with_http_info(list_id, contact_emails, opts = {})
@@ -196,8 +196,8 @@ module SibApiV3Sdk
196
196
  end
197
197
  return data, status_code, headers
198
198
  end
199
- # Create a contact to trigger the DOI workflow from a Landing Page form
200
- # @param create_doi_contact Values to create the DOI contact
199
+ # Create Contact via DOI (Double-Opt-In) Flow
200
+ # @param create_doi_contact Values to create the Double opt-in (DOI) contact
201
201
  # @param [Hash] opts the optional parameters
202
202
  # @return [nil]
203
203
  def create_doi_contact(create_doi_contact, opts = {})
@@ -205,8 +205,8 @@ module SibApiV3Sdk
205
205
  nil
206
206
  end
207
207
 
208
- # Create a contact to trigger the DOI workflow from a Landing Page form
209
- # @param create_doi_contact Values to create the DOI contact
208
+ # Create Contact via DOI (Double-Opt-In) Flow
209
+ # @param create_doi_contact Values to create the Double opt-in (DOI) contact
210
210
  # @param [Hash] opts the optional parameters
211
211
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
212
212
  def create_doi_contact_with_http_info(create_doi_contact, opts = {})
@@ -413,28 +413,28 @@ module SibApiV3Sdk
413
413
  return data, status_code, headers
414
414
  end
415
415
  # Delete a contact
416
- # @param email Email (urlencoded) of the contact
416
+ # @param identifier Email (urlencoded) OR ID of the contact
417
417
  # @param [Hash] opts the optional parameters
418
418
  # @return [nil]
419
- def delete_contact(email, opts = {})
420
- delete_contact_with_http_info(email, opts)
419
+ def delete_contact(identifier, opts = {})
420
+ delete_contact_with_http_info(identifier, opts)
421
421
  nil
422
422
  end
423
423
 
424
424
  # Delete a contact
425
- # @param email Email (urlencoded) of the contact
425
+ # @param identifier Email (urlencoded) OR ID of the contact
426
426
  # @param [Hash] opts the optional parameters
427
427
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
428
- def delete_contact_with_http_info(email, opts = {})
428
+ def delete_contact_with_http_info(identifier, opts = {})
429
429
  if @api_client.config.debugging
430
430
  @api_client.config.logger.debug 'Calling API: ContactsApi.delete_contact ...'
431
431
  end
432
- # verify the required parameter 'email' is set
433
- if @api_client.config.client_side_validation && email.nil?
434
- fail ArgumentError, "Missing the required parameter 'email' when calling ContactsApi.delete_contact"
432
+ # verify the required parameter 'identifier' is set
433
+ if @api_client.config.client_side_validation && identifier.nil?
434
+ fail ArgumentError, "Missing the required parameter 'identifier' when calling ContactsApi.delete_contact"
435
435
  end
436
436
  # resource path
437
- local_var_path = '/contacts/{email}'.sub('{' + 'email' + '}', email.to_s)
437
+ local_var_path = '/contacts/{identifier}'.sub('{' + 'identifier' + '}', identifier.to_s)
438
438
 
439
439
  # query parameters
440
440
  query_params = {}
@@ -612,28 +612,28 @@ module SibApiV3Sdk
612
612
  return data, status_code, headers
613
613
  end
614
614
  # Get a contact's details
615
- # @param email Email (urlencoded) of the contact OR its SMS attribute value
615
+ # @param identifier Email (urlencoded) OR ID of the contact OR its SMS attribute value
616
616
  # @param [Hash] opts the optional parameters
617
617
  # @return [GetExtendedContactDetails]
618
- def get_contact_info(email, opts = {})
619
- data, _status_code, _headers = get_contact_info_with_http_info(email, opts)
618
+ def get_contact_info(identifier, opts = {})
619
+ data, _status_code, _headers = get_contact_info_with_http_info(identifier, opts)
620
620
  data
621
621
  end
622
622
 
623
623
  # Get a contact&#39;s details
624
- # @param email Email (urlencoded) of the contact OR its SMS attribute value
624
+ # @param identifier Email (urlencoded) OR ID of the contact OR its SMS attribute value
625
625
  # @param [Hash] opts the optional parameters
626
626
  # @return [Array<(GetExtendedContactDetails, Fixnum, Hash)>] GetExtendedContactDetails data, response status code and response headers
627
- def get_contact_info_with_http_info(email, opts = {})
627
+ def get_contact_info_with_http_info(identifier, opts = {})
628
628
  if @api_client.config.debugging
629
629
  @api_client.config.logger.debug 'Calling API: ContactsApi.get_contact_info ...'
630
630
  end
631
- # verify the required parameter 'email' is set
632
- if @api_client.config.client_side_validation && email.nil?
633
- fail ArgumentError, "Missing the required parameter 'email' when calling ContactsApi.get_contact_info"
631
+ # verify the required parameter 'identifier' is set
632
+ if @api_client.config.client_side_validation && identifier.nil?
633
+ fail ArgumentError, "Missing the required parameter 'identifier' when calling ContactsApi.get_contact_info"
634
634
  end
635
635
  # resource path
636
- local_var_path = '/contacts/{email}'.sub('{' + 'email' + '}', email.to_s)
636
+ local_var_path = '/contacts/{identifier}'.sub('{' + 'identifier' + '}', identifier.to_s)
637
637
 
638
638
  # query parameters
639
639
  query_params = {}
@@ -664,32 +664,32 @@ module SibApiV3Sdk
664
664
  return data, status_code, headers
665
665
  end
666
666
  # Get email campaigns' statistics for a contact
667
- # @param email Email address (urlencoded) of the contact
667
+ # @param identifier Email (urlencoded) OR ID of the contact
668
668
  # @param [Hash] opts the optional parameters
669
669
  # @option opts [Date] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
670
670
  # @option opts [Date] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
671
671
  # @return [GetContactCampaignStats]
672
- def get_contact_stats(email, opts = {})
673
- data, _status_code, _headers = get_contact_stats_with_http_info(email, opts)
672
+ def get_contact_stats(identifier, opts = {})
673
+ data, _status_code, _headers = get_contact_stats_with_http_info(identifier, opts)
674
674
  data
675
675
  end
676
676
 
677
677
  # Get email campaigns&#39; statistics for a contact
678
- # @param email Email address (urlencoded) of the contact
678
+ # @param identifier Email (urlencoded) OR ID of the contact
679
679
  # @param [Hash] opts the optional parameters
680
680
  # @option opts [Date] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
681
681
  # @option opts [Date] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
682
682
  # @return [Array<(GetContactCampaignStats, Fixnum, Hash)>] GetContactCampaignStats data, response status code and response headers
683
- def get_contact_stats_with_http_info(email, opts = {})
683
+ def get_contact_stats_with_http_info(identifier, opts = {})
684
684
  if @api_client.config.debugging
685
685
  @api_client.config.logger.debug 'Calling API: ContactsApi.get_contact_stats ...'
686
686
  end
687
- # verify the required parameter 'email' is set
688
- if @api_client.config.client_side_validation && email.nil?
689
- fail ArgumentError, "Missing the required parameter 'email' when calling ContactsApi.get_contact_stats"
687
+ # verify the required parameter 'identifier' is set
688
+ if @api_client.config.client_side_validation && identifier.nil?
689
+ fail ArgumentError, "Missing the required parameter 'identifier' when calling ContactsApi.get_contact_stats"
690
690
  end
691
691
  # resource path
692
- local_var_path = '/contacts/{email}/campaignStats'.sub('{' + 'email' + '}', email.to_s)
692
+ local_var_path = '/contacts/{identifier}/campaignStats'.sub('{' + 'identifier' + '}', identifier.to_s)
693
693
 
694
694
  # query parameters
695
695
  query_params = {}
@@ -1187,7 +1187,7 @@ module SibApiV3Sdk
1187
1187
  end
1188
1188
  # Delete a contact from a list
1189
1189
  # @param list_id Id of the list
1190
- # @param contact_emails Emails adresses of the contact
1190
+ # @param contact_emails Emails addresses OR IDs of the contacts
1191
1191
  # @param [Hash] opts the optional parameters
1192
1192
  # @return [PostContactInfo]
1193
1193
  def remove_contact_from_list(list_id, contact_emails, opts = {})
@@ -1197,7 +1197,7 @@ module SibApiV3Sdk
1197
1197
 
1198
1198
  # Delete a contact from a list
1199
1199
  # @param list_id Id of the list
1200
- # @param contact_emails Emails adresses of the contact
1200
+ # @param contact_emails Emails addresses OR IDs of the contacts
1201
1201
  # @param [Hash] opts the optional parameters
1202
1202
  # @return [Array<(PostContactInfo, Fixnum, Hash)>] PostContactInfo data, response status code and response headers
1203
1203
  def remove_contact_from_list_with_http_info(list_id, contact_emails, opts = {})
@@ -1365,34 +1365,34 @@ module SibApiV3Sdk
1365
1365
  return data, status_code, headers
1366
1366
  end
1367
1367
  # Update a contact
1368
- # @param email Email (urlencoded) of the contact
1368
+ # @param identifier Email (urlencoded) OR ID of the contact
1369
1369
  # @param update_contact Values to update a contact
1370
1370
  # @param [Hash] opts the optional parameters
1371
1371
  # @return [nil]
1372
- def update_contact(email, update_contact, opts = {})
1373
- update_contact_with_http_info(email, update_contact, opts)
1372
+ def update_contact(identifier, update_contact, opts = {})
1373
+ update_contact_with_http_info(identifier, update_contact, opts)
1374
1374
  nil
1375
1375
  end
1376
1376
 
1377
1377
  # Update a contact
1378
- # @param email Email (urlencoded) of the contact
1378
+ # @param identifier Email (urlencoded) OR ID of the contact
1379
1379
  # @param update_contact Values to update a contact
1380
1380
  # @param [Hash] opts the optional parameters
1381
1381
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1382
- def update_contact_with_http_info(email, update_contact, opts = {})
1382
+ def update_contact_with_http_info(identifier, update_contact, opts = {})
1383
1383
  if @api_client.config.debugging
1384
1384
  @api_client.config.logger.debug 'Calling API: ContactsApi.update_contact ...'
1385
1385
  end
1386
- # verify the required parameter 'email' is set
1387
- if @api_client.config.client_side_validation && email.nil?
1388
- fail ArgumentError, "Missing the required parameter 'email' when calling ContactsApi.update_contact"
1386
+ # verify the required parameter 'identifier' is set
1387
+ if @api_client.config.client_side_validation && identifier.nil?
1388
+ fail ArgumentError, "Missing the required parameter 'identifier' when calling ContactsApi.update_contact"
1389
1389
  end
1390
1390
  # verify the required parameter 'update_contact' is set
1391
1391
  if @api_client.config.client_side_validation && update_contact.nil?
1392
1392
  fail ArgumentError, "Missing the required parameter 'update_contact' when calling ContactsApi.update_contact"
1393
1393
  end
1394
1394
  # resource path
1395
- local_var_path = '/contacts/{email}'.sub('{' + 'email' + '}', email.to_s)
1395
+ local_var_path = '/contacts/{identifier}'.sub('{' + 'identifier' + '}', identifier.to_s)
1396
1396
 
1397
1397
  # query parameters
1398
1398
  query_params = {}
@@ -21,7 +21,7 @@ module SibApiV3Sdk
21
21
  end
22
22
  # Add existing contacts to a list
23
23
  # @param list_id Id of the list
24
- # @param contact_emails Emails addresses of the contacts
24
+ # @param contact_emails Emails addresses OR IDs of the contacts
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [PostContactInfo]
27
27
  def add_contact_to_list(list_id, contact_emails, opts = {})
@@ -31,7 +31,7 @@ module SibApiV3Sdk
31
31
 
32
32
  # Add existing contacts to a list
33
33
  # @param list_id Id of the list
34
- # @param contact_emails Emails addresses of the contacts
34
+ # @param contact_emails Emails addresses OR IDs of the contacts
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(PostContactInfo, Fixnum, Hash)>] PostContactInfo data, response status code and response headers
37
37
  def add_contact_to_list_with_http_info(list_id, contact_emails, opts = {})
@@ -417,7 +417,7 @@ module SibApiV3Sdk
417
417
  end
418
418
  # Delete a contact from a list
419
419
  # @param list_id Id of the list
420
- # @param contact_emails Emails adresses of the contact
420
+ # @param contact_emails Emails addresses OR IDs of the contacts
421
421
  # @param [Hash] opts the optional parameters
422
422
  # @return [PostContactInfo]
423
423
  def remove_contact_from_list(list_id, contact_emails, opts = {})
@@ -427,7 +427,7 @@ module SibApiV3Sdk
427
427
 
428
428
  # Delete a contact from a list
429
429
  # @param list_id Id of the list
430
- # @param contact_emails Emails adresses of the contact
430
+ # @param contact_emails Emails addresses OR IDs of the contacts
431
431
  # @param [Hash] opts the optional parameters
432
432
  # @return [Array<(PostContactInfo, Fixnum, Hash)>] PostContactInfo data, response status code and response headers
433
433
  def remove_contact_from_list_with_http_info(list_id, contact_emails, opts = {})
@@ -20,34 +20,34 @@ module SibApiV3Sdk
20
20
  @api_client = api_client
21
21
  end
22
22
  # Add Email and/or SMS credits to a specific child account
23
- # @param child_auth_key auth key of reseller&#39;s child
23
+ # @param child_identifier Either auth key or id of reseller&#39;s child
24
24
  # @param add_credits Values to post to add credit to a specific child account
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [RemainingCreditModel]
27
- def add_credits(child_auth_key, add_credits, opts = {})
28
- data, _status_code, _headers = add_credits_with_http_info(child_auth_key, add_credits, opts)
27
+ def add_credits(child_identifier, add_credits, opts = {})
28
+ data, _status_code, _headers = add_credits_with_http_info(child_identifier, add_credits, opts)
29
29
  data
30
30
  end
31
31
 
32
32
  # Add Email and/or SMS credits to a specific child account
33
- # @param child_auth_key auth key of reseller&#39;s child
33
+ # @param child_identifier Either auth key or id of reseller&#39;s child
34
34
  # @param add_credits Values to post to add credit to a specific child account
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(RemainingCreditModel, Fixnum, Hash)>] RemainingCreditModel data, response status code and response headers
37
- def add_credits_with_http_info(child_auth_key, add_credits, opts = {})
37
+ def add_credits_with_http_info(child_identifier, add_credits, opts = {})
38
38
  if @api_client.config.debugging
39
39
  @api_client.config.logger.debug 'Calling API: ResellerApi.add_credits ...'
40
40
  end
41
- # verify the required parameter 'child_auth_key' is set
42
- if @api_client.config.client_side_validation && child_auth_key.nil?
43
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.add_credits"
41
+ # verify the required parameter 'child_identifier' is set
42
+ if @api_client.config.client_side_validation && child_identifier.nil?
43
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.add_credits"
44
44
  end
45
45
  # verify the required parameter 'add_credits' is set
46
46
  if @api_client.config.client_side_validation && add_credits.nil?
47
47
  fail ArgumentError, "Missing the required parameter 'add_credits' when calling ResellerApi.add_credits"
48
48
  end
49
49
  # resource path
50
- local_var_path = '/reseller/children/{childAuthKey}/credits/add'.sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
50
+ local_var_path = '/reseller/children/{childIdentifier}/credits/add'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
51
51
 
52
52
  # query parameters
53
53
  query_params = {}
@@ -78,34 +78,34 @@ module SibApiV3Sdk
78
78
  return data, status_code, headers
79
79
  end
80
80
  # Associate a dedicated IP to the child
81
- # @param child_auth_key auth key of reseller&#39;s child
81
+ # @param child_identifier Either auth key or id of reseller&#39;s child
82
82
  # @param ip IP to associate
83
83
  # @param [Hash] opts the optional parameters
84
84
  # @return [nil]
85
- def associate_ip_to_child(child_auth_key, ip, opts = {})
86
- associate_ip_to_child_with_http_info(child_auth_key, ip, opts)
85
+ def associate_ip_to_child(child_identifier, ip, opts = {})
86
+ associate_ip_to_child_with_http_info(child_identifier, ip, opts)
87
87
  nil
88
88
  end
89
89
 
90
90
  # Associate a dedicated IP to the child
91
- # @param child_auth_key auth key of reseller&#39;s child
91
+ # @param child_identifier Either auth key or id of reseller&#39;s child
92
92
  # @param ip IP to associate
93
93
  # @param [Hash] opts the optional parameters
94
94
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
95
- def associate_ip_to_child_with_http_info(child_auth_key, ip, opts = {})
95
+ def associate_ip_to_child_with_http_info(child_identifier, ip, opts = {})
96
96
  if @api_client.config.debugging
97
97
  @api_client.config.logger.debug 'Calling API: ResellerApi.associate_ip_to_child ...'
98
98
  end
99
- # verify the required parameter 'child_auth_key' is set
100
- if @api_client.config.client_side_validation && child_auth_key.nil?
101
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.associate_ip_to_child"
99
+ # verify the required parameter 'child_identifier' is set
100
+ if @api_client.config.client_side_validation && child_identifier.nil?
101
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.associate_ip_to_child"
102
102
  end
103
103
  # verify the required parameter 'ip' is set
104
104
  if @api_client.config.client_side_validation && ip.nil?
105
105
  fail ArgumentError, "Missing the required parameter 'ip' when calling ResellerApi.associate_ip_to_child"
106
106
  end
107
107
  # resource path
108
- local_var_path = '/reseller/children/{childAuthKey}/ips/associate'.sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
108
+ local_var_path = '/reseller/children/{childIdentifier}/ips/associate'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
109
109
 
110
110
  # query parameters
111
111
  query_params = {}
@@ -135,34 +135,34 @@ module SibApiV3Sdk
135
135
  return data, status_code, headers
136
136
  end
137
137
  # Create a domain for a child account
138
- # @param child_auth_key auth key of reseller&#39;s child
138
+ # @param child_identifier Either auth key or id of reseller&#39;s child
139
139
  # @param add_child_domain Sender domain to add for a specific child account. This will not be displayed to the parent account.
140
140
  # @param [Hash] opts the optional parameters
141
141
  # @return [nil]
142
- def create_child_domain(child_auth_key, add_child_domain, opts = {})
143
- create_child_domain_with_http_info(child_auth_key, add_child_domain, opts)
142
+ def create_child_domain(child_identifier, add_child_domain, opts = {})
143
+ create_child_domain_with_http_info(child_identifier, add_child_domain, opts)
144
144
  nil
145
145
  end
146
146
 
147
147
  # Create a domain for a child account
148
- # @param child_auth_key auth key of reseller&#39;s child
148
+ # @param child_identifier Either auth key or id of reseller&#39;s child
149
149
  # @param add_child_domain Sender domain to add for a specific child account. This will not be displayed to the parent account.
150
150
  # @param [Hash] opts the optional parameters
151
151
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
152
- def create_child_domain_with_http_info(child_auth_key, add_child_domain, opts = {})
152
+ def create_child_domain_with_http_info(child_identifier, add_child_domain, opts = {})
153
153
  if @api_client.config.debugging
154
154
  @api_client.config.logger.debug 'Calling API: ResellerApi.create_child_domain ...'
155
155
  end
156
- # verify the required parameter 'child_auth_key' is set
157
- if @api_client.config.client_side_validation && child_auth_key.nil?
158
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.create_child_domain"
156
+ # verify the required parameter 'child_identifier' is set
157
+ if @api_client.config.client_side_validation && child_identifier.nil?
158
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.create_child_domain"
159
159
  end
160
160
  # verify the required parameter 'add_child_domain' is set
161
161
  if @api_client.config.client_side_validation && add_child_domain.nil?
162
162
  fail ArgumentError, "Missing the required parameter 'add_child_domain' when calling ResellerApi.create_child_domain"
163
163
  end
164
164
  # resource path
165
- local_var_path = '/reseller/children/{childAuthKey}/domains'.sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
165
+ local_var_path = '/reseller/children/{childIdentifier}/domains'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
166
166
 
167
167
  # query parameters
168
168
  query_params = {}
@@ -239,35 +239,35 @@ module SibApiV3Sdk
239
239
  end
240
240
  return data, status_code, headers
241
241
  end
242
- # Delete the sender domain of the reseller child based on the childAuthKey and domainName passed
243
- # @param child_auth_key auth key of reseller&#39;s child
242
+ # Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
243
+ # @param child_identifier Either auth key or id of reseller&#39;s child
244
244
  # @param domain_name Pass the existing domain that needs to be deleted
245
245
  # @param [Hash] opts the optional parameters
246
246
  # @return [nil]
247
- def delete_child_domain(child_auth_key, domain_name, opts = {})
248
- delete_child_domain_with_http_info(child_auth_key, domain_name, opts)
247
+ def delete_child_domain(child_identifier, domain_name, opts = {})
248
+ delete_child_domain_with_http_info(child_identifier, domain_name, opts)
249
249
  nil
250
250
  end
251
251
 
252
- # Delete the sender domain of the reseller child based on the childAuthKey and domainName passed
253
- # @param child_auth_key auth key of reseller&#39;s child
252
+ # Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
253
+ # @param child_identifier Either auth key or id of reseller&#39;s child
254
254
  # @param domain_name Pass the existing domain that needs to be deleted
255
255
  # @param [Hash] opts the optional parameters
256
256
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
257
- def delete_child_domain_with_http_info(child_auth_key, domain_name, opts = {})
257
+ def delete_child_domain_with_http_info(child_identifier, domain_name, opts = {})
258
258
  if @api_client.config.debugging
259
259
  @api_client.config.logger.debug 'Calling API: ResellerApi.delete_child_domain ...'
260
260
  end
261
- # verify the required parameter 'child_auth_key' is set
262
- if @api_client.config.client_side_validation && child_auth_key.nil?
263
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.delete_child_domain"
261
+ # verify the required parameter 'child_identifier' is set
262
+ if @api_client.config.client_side_validation && child_identifier.nil?
263
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.delete_child_domain"
264
264
  end
265
265
  # verify the required parameter 'domain_name' is set
266
266
  if @api_client.config.client_side_validation && domain_name.nil?
267
267
  fail ArgumentError, "Missing the required parameter 'domain_name' when calling ResellerApi.delete_child_domain"
268
268
  end
269
269
  # resource path
270
- local_var_path = '/reseller/children/{childAuthKey}/domains/{domainName}'.sub('{' + 'childAuthKey' + '}', child_auth_key.to_s).sub('{' + 'domainName' + '}', domain_name.to_s)
270
+ local_var_path = '/reseller/children/{childIdentifier}/domains/{domainName}'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s).sub('{' + 'domainName' + '}', domain_name.to_s)
271
271
 
272
272
  # query parameters
273
273
  query_params = {}
@@ -296,29 +296,29 @@ module SibApiV3Sdk
296
296
  end
297
297
  return data, status_code, headers
298
298
  end
299
- # Delete a single reseller child based on the childAuthKey supplied
300
- # @param child_auth_key auth key of reseller&#39;s child
299
+ # Delete a single reseller child based on the child identifier supplied
300
+ # @param child_identifier Either auth key or child id of reseller&#39;s child
301
301
  # @param [Hash] opts the optional parameters
302
302
  # @return [nil]
303
- def delete_reseller_child(child_auth_key, opts = {})
304
- delete_reseller_child_with_http_info(child_auth_key, opts)
303
+ def delete_reseller_child(child_identifier, opts = {})
304
+ delete_reseller_child_with_http_info(child_identifier, opts)
305
305
  nil
306
306
  end
307
307
 
308
- # Delete a single reseller child based on the childAuthKey supplied
309
- # @param child_auth_key auth key of reseller&#39;s child
308
+ # Delete a single reseller child based on the child identifier supplied
309
+ # @param child_identifier Either auth key or child id of reseller&#39;s child
310
310
  # @param [Hash] opts the optional parameters
311
311
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
312
- def delete_reseller_child_with_http_info(child_auth_key, opts = {})
312
+ def delete_reseller_child_with_http_info(child_identifier, opts = {})
313
313
  if @api_client.config.debugging
314
314
  @api_client.config.logger.debug 'Calling API: ResellerApi.delete_reseller_child ...'
315
315
  end
316
- # verify the required parameter 'child_auth_key' is set
317
- if @api_client.config.client_side_validation && child_auth_key.nil?
318
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.delete_reseller_child"
316
+ # verify the required parameter 'child_identifier' is set
317
+ if @api_client.config.client_side_validation && child_identifier.nil?
318
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.delete_reseller_child"
319
319
  end
320
320
  # resource path
321
- local_var_path = '/reseller/children/{childAuthKey}'.sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
321
+ local_var_path = '/reseller/children/{childIdentifier}'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
322
322
 
323
323
  # query parameters
324
324
  query_params = {}
@@ -348,34 +348,34 @@ module SibApiV3Sdk
348
348
  return data, status_code, headers
349
349
  end
350
350
  # Dissociate a dedicated IP to the child
351
- # @param child_auth_key auth key of reseller&#39;s child
351
+ # @param child_identifier Either auth key or id of reseller&#39;s child
352
352
  # @param ip IP to dissociate
353
353
  # @param [Hash] opts the optional parameters
354
354
  # @return [nil]
355
- def dissociate_ip_from_child(child_auth_key, ip, opts = {})
356
- dissociate_ip_from_child_with_http_info(child_auth_key, ip, opts)
355
+ def dissociate_ip_from_child(child_identifier, ip, opts = {})
356
+ dissociate_ip_from_child_with_http_info(child_identifier, ip, opts)
357
357
  nil
358
358
  end
359
359
 
360
360
  # Dissociate a dedicated IP to the child
361
- # @param child_auth_key auth key of reseller&#39;s child
361
+ # @param child_identifier Either auth key or id of reseller&#39;s child
362
362
  # @param ip IP to dissociate
363
363
  # @param [Hash] opts the optional parameters
364
364
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
365
- def dissociate_ip_from_child_with_http_info(child_auth_key, ip, opts = {})
365
+ def dissociate_ip_from_child_with_http_info(child_identifier, ip, opts = {})
366
366
  if @api_client.config.debugging
367
367
  @api_client.config.logger.debug 'Calling API: ResellerApi.dissociate_ip_from_child ...'
368
368
  end
369
- # verify the required parameter 'child_auth_key' is set
370
- if @api_client.config.client_side_validation && child_auth_key.nil?
371
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.dissociate_ip_from_child"
369
+ # verify the required parameter 'child_identifier' is set
370
+ if @api_client.config.client_side_validation && child_identifier.nil?
371
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.dissociate_ip_from_child"
372
372
  end
373
373
  # verify the required parameter 'ip' is set
374
374
  if @api_client.config.client_side_validation && ip.nil?
375
375
  fail ArgumentError, "Missing the required parameter 'ip' when calling ResellerApi.dissociate_ip_from_child"
376
376
  end
377
377
  # resource path
378
- local_var_path = '/reseller/children/{childAuthKey}/ips/dissociate'.sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
378
+ local_var_path = '/reseller/children/{childIdentifier}/ips/dissociate'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
379
379
 
380
380
  # query parameters
381
381
  query_params = {}
@@ -404,29 +404,29 @@ module SibApiV3Sdk
404
404
  end
405
405
  return data, status_code, headers
406
406
  end
407
- # Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
408
- # @param child_auth_key auth key of reseller&#39;s child
407
+ # Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied
408
+ # @param child_identifier Either auth key or id of reseller&#39;s child
409
409
  # @param [Hash] opts the optional parameters
410
410
  # @return [GetChildAccountCreationStatus]
411
- def get_child_account_creation_status(child_auth_key, opts = {})
412
- data, _status_code, _headers = get_child_account_creation_status_with_http_info(child_auth_key, opts)
411
+ def get_child_account_creation_status(child_identifier, opts = {})
412
+ data, _status_code, _headers = get_child_account_creation_status_with_http_info(child_identifier, opts)
413
413
  data
414
414
  end
415
415
 
416
- # Get the status of a reseller&#39;s child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
417
- # @param child_auth_key auth key of reseller&#39;s child
416
+ # Get the status of a reseller&#39;s child account creation, whether it is successfully created (exists) or not based on the identifier supplied
417
+ # @param child_identifier Either auth key or id of reseller&#39;s child
418
418
  # @param [Hash] opts the optional parameters
419
419
  # @return [Array<(GetChildAccountCreationStatus, Fixnum, Hash)>] GetChildAccountCreationStatus data, response status code and response headers
420
- def get_child_account_creation_status_with_http_info(child_auth_key, opts = {})
420
+ def get_child_account_creation_status_with_http_info(child_identifier, opts = {})
421
421
  if @api_client.config.debugging
422
422
  @api_client.config.logger.debug 'Calling API: ResellerApi.get_child_account_creation_status ...'
423
423
  end
424
- # verify the required parameter 'child_auth_key' is set
425
- if @api_client.config.client_side_validation && child_auth_key.nil?
426
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.get_child_account_creation_status"
424
+ # verify the required parameter 'child_identifier' is set
425
+ if @api_client.config.client_side_validation && child_identifier.nil?
426
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.get_child_account_creation_status"
427
427
  end
428
428
  # resource path
429
- local_var_path = '/reseller/children/{childAuthKey}/accountCreationStatus'.sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
429
+ local_var_path = '/reseller/children/{childIdentifier}/accountCreationStatus'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
430
430
 
431
431
  # query parameters
432
432
  query_params = {}
@@ -457,28 +457,28 @@ module SibApiV3Sdk
457
457
  return data, status_code, headers
458
458
  end
459
459
  # Get all sender domains for a specific child account
460
- # @param child_auth_key auth key of reseller&#39;s child
460
+ # @param child_identifier Either auth key or id of reseller&#39;s child
461
461
  # @param [Hash] opts the optional parameters
462
462
  # @return [GetChildDomains]
463
- def get_child_domains(child_auth_key, opts = {})
464
- data, _status_code, _headers = get_child_domains_with_http_info(child_auth_key, opts)
463
+ def get_child_domains(child_identifier, opts = {})
464
+ data, _status_code, _headers = get_child_domains_with_http_info(child_identifier, opts)
465
465
  data
466
466
  end
467
467
 
468
468
  # Get all sender domains for a specific child account
469
- # @param child_auth_key auth key of reseller&#39;s child
469
+ # @param child_identifier Either auth key or id of reseller&#39;s child
470
470
  # @param [Hash] opts the optional parameters
471
471
  # @return [Array<(GetChildDomains, Fixnum, Hash)>] GetChildDomains data, response status code and response headers
472
- def get_child_domains_with_http_info(child_auth_key, opts = {})
472
+ def get_child_domains_with_http_info(child_identifier, opts = {})
473
473
  if @api_client.config.debugging
474
474
  @api_client.config.logger.debug 'Calling API: ResellerApi.get_child_domains ...'
475
475
  end
476
- # verify the required parameter 'child_auth_key' is set
477
- if @api_client.config.client_side_validation && child_auth_key.nil?
478
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.get_child_domains"
476
+ # verify the required parameter 'child_identifier' is set
477
+ if @api_client.config.client_side_validation && child_identifier.nil?
478
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.get_child_domains"
479
479
  end
480
480
  # resource path
481
- local_var_path = '/reseller/children/{childAuthKey}/domains'.sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
481
+ local_var_path = '/reseller/children/{childIdentifier}/domains'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
482
482
 
483
483
  # query parameters
484
484
  query_params = {}
@@ -509,28 +509,28 @@ module SibApiV3Sdk
509
509
  return data, status_code, headers
510
510
  end
511
511
  # Get a child account's details
512
- # @param child_auth_key auth key of reseller&#39;s child
512
+ # @param child_identifier Either auth key or id of reseller&#39;s child
513
513
  # @param [Hash] opts the optional parameters
514
514
  # @return [GetChildInfo]
515
- def get_child_info(child_auth_key, opts = {})
516
- data, _status_code, _headers = get_child_info_with_http_info(child_auth_key, opts)
515
+ def get_child_info(child_identifier, opts = {})
516
+ data, _status_code, _headers = get_child_info_with_http_info(child_identifier, opts)
517
517
  data
518
518
  end
519
519
 
520
520
  # Get a child account&#39;s details
521
- # @param child_auth_key auth key of reseller&#39;s child
521
+ # @param child_identifier Either auth key or id of reseller&#39;s child
522
522
  # @param [Hash] opts the optional parameters
523
523
  # @return [Array<(GetChildInfo, Fixnum, Hash)>] GetChildInfo data, response status code and response headers
524
- def get_child_info_with_http_info(child_auth_key, opts = {})
524
+ def get_child_info_with_http_info(child_identifier, opts = {})
525
525
  if @api_client.config.debugging
526
526
  @api_client.config.logger.debug 'Calling API: ResellerApi.get_child_info ...'
527
527
  end
528
- # verify the required parameter 'child_auth_key' is set
529
- if @api_client.config.client_side_validation && child_auth_key.nil?
530
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.get_child_info"
528
+ # verify the required parameter 'child_identifier' is set
529
+ if @api_client.config.client_side_validation && child_identifier.nil?
530
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.get_child_info"
531
531
  end
532
532
  # resource path
533
- local_var_path = '/reseller/children/{childAuthKey}'.sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
533
+ local_var_path = '/reseller/children/{childIdentifier}'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
534
534
 
535
535
  # query parameters
536
536
  query_params = {}
@@ -618,29 +618,29 @@ module SibApiV3Sdk
618
618
  end
619
619
  # Get session token to access Sendinblue (SSO)
620
620
  # 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 => https:/email.mydomain.com/login/sso?token=[token]
621
- # @param child_auth_key auth key of reseller&#39;s child
621
+ # @param child_identifier Either auth key or id of reseller&#39;s child
622
622
  # @param [Hash] opts the optional parameters
623
623
  # @return [GetSsoToken]
624
- def get_sso_token(child_auth_key, opts = {})
625
- data, _status_code, _headers = get_sso_token_with_http_info(child_auth_key, opts)
624
+ def get_sso_token(child_identifier, opts = {})
625
+ data, _status_code, _headers = get_sso_token_with_http_info(child_identifier, opts)
626
626
  data
627
627
  end
628
628
 
629
629
  # Get session token to access Sendinblue (SSO)
630
630
  # 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; https:/email.mydomain.com/login/sso?token&#x3D;[token]
631
- # @param child_auth_key auth key of reseller&#39;s child
631
+ # @param child_identifier Either auth key or id of reseller&#39;s child
632
632
  # @param [Hash] opts the optional parameters
633
633
  # @return [Array<(GetSsoToken, Fixnum, Hash)>] GetSsoToken data, response status code and response headers
634
- def get_sso_token_with_http_info(child_auth_key, opts = {})
634
+ def get_sso_token_with_http_info(child_identifier, opts = {})
635
635
  if @api_client.config.debugging
636
636
  @api_client.config.logger.debug 'Calling API: ResellerApi.get_sso_token ...'
637
637
  end
638
- # verify the required parameter 'child_auth_key' is set
639
- if @api_client.config.client_side_validation && child_auth_key.nil?
640
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.get_sso_token"
638
+ # verify the required parameter 'child_identifier' is set
639
+ if @api_client.config.client_side_validation && child_identifier.nil?
640
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.get_sso_token"
641
641
  end
642
642
  # resource path
643
- local_var_path = '/reseller/children/{childAuthKey}/auth'.sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
643
+ local_var_path = '/reseller/children/{childIdentifier}/auth'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
644
644
 
645
645
  # query parameters
646
646
  query_params = {}
@@ -671,34 +671,34 @@ module SibApiV3Sdk
671
671
  return data, status_code, headers
672
672
  end
673
673
  # Remove Email and/or SMS credits from a specific child account
674
- # @param child_auth_key auth key of reseller&#39;s child
674
+ # @param child_identifier Either auth key or id of reseller&#39;s child
675
675
  # @param remove_credits Values to post to remove email or SMS credits from a specific child account
676
676
  # @param [Hash] opts the optional parameters
677
677
  # @return [RemainingCreditModel]
678
- def remove_credits(child_auth_key, remove_credits, opts = {})
679
- data, _status_code, _headers = remove_credits_with_http_info(child_auth_key, remove_credits, opts)
678
+ def remove_credits(child_identifier, remove_credits, opts = {})
679
+ data, _status_code, _headers = remove_credits_with_http_info(child_identifier, remove_credits, opts)
680
680
  data
681
681
  end
682
682
 
683
683
  # Remove Email and/or SMS credits from a specific child account
684
- # @param child_auth_key auth key of reseller&#39;s child
684
+ # @param child_identifier Either auth key or id of reseller&#39;s child
685
685
  # @param remove_credits Values to post to remove email or SMS credits from a specific child account
686
686
  # @param [Hash] opts the optional parameters
687
687
  # @return [Array<(RemainingCreditModel, Fixnum, Hash)>] RemainingCreditModel data, response status code and response headers
688
- def remove_credits_with_http_info(child_auth_key, remove_credits, opts = {})
688
+ def remove_credits_with_http_info(child_identifier, remove_credits, opts = {})
689
689
  if @api_client.config.debugging
690
690
  @api_client.config.logger.debug 'Calling API: ResellerApi.remove_credits ...'
691
691
  end
692
- # verify the required parameter 'child_auth_key' is set
693
- if @api_client.config.client_side_validation && child_auth_key.nil?
694
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.remove_credits"
692
+ # verify the required parameter 'child_identifier' is set
693
+ if @api_client.config.client_side_validation && child_identifier.nil?
694
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.remove_credits"
695
695
  end
696
696
  # verify the required parameter 'remove_credits' is set
697
697
  if @api_client.config.client_side_validation && remove_credits.nil?
698
698
  fail ArgumentError, "Missing the required parameter 'remove_credits' when calling ResellerApi.remove_credits"
699
699
  end
700
700
  # resource path
701
- local_var_path = '/reseller/children/{childAuthKey}/credits/remove'.sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
701
+ local_var_path = '/reseller/children/{childIdentifier}/credits/remove'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
702
702
 
703
703
  # query parameters
704
704
  query_params = {}
@@ -728,35 +728,35 @@ module SibApiV3Sdk
728
728
  end
729
729
  return data, status_code, headers
730
730
  end
731
- # Update info of reseller's child account status based on the childAuthKey supplied
732
- # @param child_auth_key auth key of reseller&#39;s child
731
+ # Update info of reseller's child account status based on the childIdentifier supplied
732
+ # @param child_identifier Either auth key or id of reseller&#39;s child
733
733
  # @param update_child_account_status values to update in child account status
734
734
  # @param [Hash] opts the optional parameters
735
735
  # @return [nil]
736
- def update_child_account_status(child_auth_key, update_child_account_status, opts = {})
737
- update_child_account_status_with_http_info(child_auth_key, update_child_account_status, opts)
736
+ def update_child_account_status(child_identifier, update_child_account_status, opts = {})
737
+ update_child_account_status_with_http_info(child_identifier, update_child_account_status, opts)
738
738
  nil
739
739
  end
740
740
 
741
- # Update info of reseller&#39;s child account status based on the childAuthKey supplied
742
- # @param child_auth_key auth key of reseller&#39;s child
741
+ # Update info of reseller&#39;s child account status based on the childIdentifier supplied
742
+ # @param child_identifier Either auth key or id of reseller&#39;s child
743
743
  # @param update_child_account_status values to update in child account status
744
744
  # @param [Hash] opts the optional parameters
745
745
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
746
- def update_child_account_status_with_http_info(child_auth_key, update_child_account_status, opts = {})
746
+ def update_child_account_status_with_http_info(child_identifier, update_child_account_status, opts = {})
747
747
  if @api_client.config.debugging
748
748
  @api_client.config.logger.debug 'Calling API: ResellerApi.update_child_account_status ...'
749
749
  end
750
- # verify the required parameter 'child_auth_key' is set
751
- if @api_client.config.client_side_validation && child_auth_key.nil?
752
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.update_child_account_status"
750
+ # verify the required parameter 'child_identifier' is set
751
+ if @api_client.config.client_side_validation && child_identifier.nil?
752
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.update_child_account_status"
753
753
  end
754
754
  # verify the required parameter 'update_child_account_status' is set
755
755
  if @api_client.config.client_side_validation && update_child_account_status.nil?
756
756
  fail ArgumentError, "Missing the required parameter 'update_child_account_status' when calling ResellerApi.update_child_account_status"
757
757
  end
758
758
  # resource path
759
- local_var_path = '/reseller/children/{childAuthKey}/accountStatus'.sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
759
+ local_var_path = '/reseller/children/{childIdentifier}/accountStatus'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
760
760
 
761
761
  # query parameters
762
762
  query_params = {}
@@ -785,30 +785,30 @@ module SibApiV3Sdk
785
785
  end
786
786
  return data, status_code, headers
787
787
  end
788
- # Update the sender domain of reseller's child based on the childAuthKey and domainName passed
789
- # @param child_auth_key auth key of reseller&#39;s child
788
+ # Update the sender domain of reseller's child based on the childIdentifier and domainName passed
789
+ # @param child_identifier Either auth key or id of reseller&#39;s child
790
790
  # @param domain_name Pass the existing domain that needs to be updated
791
791
  # @param update_child_domain value to update for sender domain
792
792
  # @param [Hash] opts the optional parameters
793
793
  # @return [nil]
794
- def update_child_domain(child_auth_key, domain_name, update_child_domain, opts = {})
795
- update_child_domain_with_http_info(child_auth_key, domain_name, update_child_domain, opts)
794
+ def update_child_domain(child_identifier, domain_name, update_child_domain, opts = {})
795
+ update_child_domain_with_http_info(child_identifier, domain_name, update_child_domain, opts)
796
796
  nil
797
797
  end
798
798
 
799
- # Update the sender domain of reseller&#39;s child based on the childAuthKey and domainName passed
800
- # @param child_auth_key auth key of reseller&#39;s child
799
+ # Update the sender domain of reseller&#39;s child based on the childIdentifier and domainName passed
800
+ # @param child_identifier Either auth key or id of reseller&#39;s child
801
801
  # @param domain_name Pass the existing domain that needs to be updated
802
802
  # @param update_child_domain value to update for sender domain
803
803
  # @param [Hash] opts the optional parameters
804
804
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
805
- def update_child_domain_with_http_info(child_auth_key, domain_name, update_child_domain, opts = {})
805
+ def update_child_domain_with_http_info(child_identifier, domain_name, update_child_domain, opts = {})
806
806
  if @api_client.config.debugging
807
807
  @api_client.config.logger.debug 'Calling API: ResellerApi.update_child_domain ...'
808
808
  end
809
- # verify the required parameter 'child_auth_key' is set
810
- if @api_client.config.client_side_validation && child_auth_key.nil?
811
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.update_child_domain"
809
+ # verify the required parameter 'child_identifier' is set
810
+ if @api_client.config.client_side_validation && child_identifier.nil?
811
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.update_child_domain"
812
812
  end
813
813
  # verify the required parameter 'domain_name' is set
814
814
  if @api_client.config.client_side_validation && domain_name.nil?
@@ -819,7 +819,7 @@ module SibApiV3Sdk
819
819
  fail ArgumentError, "Missing the required parameter 'update_child_domain' when calling ResellerApi.update_child_domain"
820
820
  end
821
821
  # resource path
822
- local_var_path = '/reseller/children/{childAuthKey}/domains/{domainName}'.sub('{' + 'childAuthKey' + '}', child_auth_key.to_s).sub('{' + 'domainName' + '}', domain_name.to_s)
822
+ local_var_path = '/reseller/children/{childIdentifier}/domains/{domainName}'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s).sub('{' + 'domainName' + '}', domain_name.to_s)
823
823
 
824
824
  # query parameters
825
825
  query_params = {}
@@ -848,35 +848,35 @@ module SibApiV3Sdk
848
848
  end
849
849
  return data, status_code, headers
850
850
  end
851
- # Update info of reseller's child based on the childAuthKey supplied
852
- # @param child_auth_key auth key of reseller&#39;s child
851
+ # Update info of reseller's child based on the child identifier supplied
852
+ # @param child_identifier Either auth key or id of reseller&#39;s child
853
853
  # @param reseller_child values to update in child profile
854
854
  # @param [Hash] opts the optional parameters
855
855
  # @return [nil]
856
- def update_reseller_child(child_auth_key, reseller_child, opts = {})
857
- update_reseller_child_with_http_info(child_auth_key, reseller_child, opts)
856
+ def update_reseller_child(child_identifier, reseller_child, opts = {})
857
+ update_reseller_child_with_http_info(child_identifier, reseller_child, opts)
858
858
  nil
859
859
  end
860
860
 
861
- # Update info of reseller&#39;s child based on the childAuthKey supplied
862
- # @param child_auth_key auth key of reseller&#39;s child
861
+ # Update info of reseller&#39;s child based on the child identifier supplied
862
+ # @param child_identifier Either auth key or id of reseller&#39;s child
863
863
  # @param reseller_child values to update in child profile
864
864
  # @param [Hash] opts the optional parameters
865
865
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
866
- def update_reseller_child_with_http_info(child_auth_key, reseller_child, opts = {})
866
+ def update_reseller_child_with_http_info(child_identifier, reseller_child, opts = {})
867
867
  if @api_client.config.debugging
868
868
  @api_client.config.logger.debug 'Calling API: ResellerApi.update_reseller_child ...'
869
869
  end
870
- # verify the required parameter 'child_auth_key' is set
871
- if @api_client.config.client_side_validation && child_auth_key.nil?
872
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.update_reseller_child"
870
+ # verify the required parameter 'child_identifier' is set
871
+ if @api_client.config.client_side_validation && child_identifier.nil?
872
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.update_reseller_child"
873
873
  end
874
874
  # verify the required parameter 'reseller_child' is set
875
875
  if @api_client.config.client_side_validation && reseller_child.nil?
876
876
  fail ArgumentError, "Missing the required parameter 'reseller_child' when calling ResellerApi.update_reseller_child"
877
877
  end
878
878
  # resource path
879
- local_var_path = '/reseller/children/{childAuthKey}'.sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
879
+ local_var_path = '/reseller/children/{childIdentifier}'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
880
880
 
881
881
  # query parameters
882
882
  query_params = {}