sib-api-v3-sdk 3.0.1 → 4.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (58) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +14 -11
  3. data/docs/AddContactToList.md +8 -0
  4. data/docs/AddCredits.md +2 -2
  5. data/docs/ContactsApi.md +9 -9
  6. data/docs/CreateReseller.md +8 -0
  7. data/docs/GetChildInfo.md +2 -2
  8. data/docs/GetChildInfoApiKeys.md +2 -3
  9. data/docs/GetChildInfoApiKeysV2.md +9 -0
  10. data/docs/GetChildInfoApiKeysV3.md +9 -0
  11. data/docs/GetEmailCampaign.md +2 -0
  12. data/docs/GetSmsCampaign.md +2 -0
  13. data/docs/ListsApi.md +9 -9
  14. data/docs/ManageIp.md +1 -1
  15. data/docs/RemoveContactFromList.md +9 -0
  16. data/docs/RemoveCredits.md +2 -2
  17. data/docs/ResellerApi.md +45 -45
  18. data/docs/SendSmtpEmail.md +7 -5
  19. data/docs/UpdateChild.md +0 -1
  20. data/lib/sib-api-v3-sdk.rb +5 -2
  21. data/lib/sib-api-v3-sdk/api/contacts_api.rb +7 -7
  22. data/lib/sib-api-v3-sdk/api/lists_api.rb +7 -7
  23. data/lib/sib-api-v3-sdk/api/reseller_api.rb +82 -82
  24. data/lib/sib-api-v3-sdk/models/{add_remove_contact_to_list.rb → add_contact_to_list.rb} +2 -2
  25. data/lib/sib-api-v3-sdk/models/add_credits.rb +2 -2
  26. data/lib/sib-api-v3-sdk/models/create_reseller.rb +194 -0
  27. data/lib/sib-api-v3-sdk/models/error_model.rb +2 -2
  28. data/lib/sib-api-v3-sdk/models/get_child_info.rb +3 -6
  29. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +21 -34
  30. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +209 -0
  31. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +209 -0
  32. data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +32 -4
  33. data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +32 -4
  34. data/lib/sib-api-v3-sdk/models/manage_ip.rb +8 -8
  35. data/lib/sib-api-v3-sdk/models/{get_child_info_ips.rb → remove_contact_from_list.rb} +18 -26
  36. data/lib/sib-api-v3-sdk/models/remove_credits.rb +2 -2
  37. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +29 -23
  38. data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +1 -1
  39. data/lib/sib-api-v3-sdk/models/update_child.rb +4 -15
  40. data/lib/sib-api-v3-sdk/version.rb +1 -1
  41. data/spec/api/contacts_api_spec.rb +2 -2
  42. data/spec/api/lists_api_spec.rb +2 -2
  43. data/spec/api/reseller_api_spec.rb +12 -12
  44. data/spec/models/{add_remove_contact_to_list_spec.rb → add_contact_to_list_spec.rb} +6 -6
  45. data/spec/models/create_reseller_spec.rb +42 -0
  46. data/spec/models/error_model_spec.rb +1 -1
  47. data/spec/models/get_child_info_api_keys_spec.rb +2 -8
  48. data/spec/models/{get_child_info_ips_spec.rb → get_child_info_api_keys_v2_spec.rb} +8 -8
  49. data/spec/models/get_child_info_api_keys_v3_spec.rb +48 -0
  50. data/spec/models/get_email_campaign_spec.rb +12 -0
  51. data/spec/models/get_sms_campaign_spec.rb +12 -0
  52. data/spec/models/manage_ip_spec.rb +1 -1
  53. data/spec/models/remove_contact_from_list_spec.rb +48 -0
  54. data/spec/models/send_smtp_email_spec.rb +12 -0
  55. data/spec/models/update_child_spec.rb +0 -6
  56. metadata +22 -10
  57. data/docs/AddRemoveContactToList.md +0 -8
  58. data/docs/GetChildInfoIps.md +0 -9
@@ -3,15 +3,17 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **sender** | [**SendSmtpEmailSender**](SendSmtpEmailSender.md) | |
6
+ **sender** | [**SendSmtpEmailSender**](SendSmtpEmailSender.md) | | [optional]
7
7
  **to** | [**Array<SendSmtpEmailTo>**](SendSmtpEmailTo.md) | Email addresses and names of the recipients |
8
8
  **bcc** | [**Array<SendSmtpEmailBcc>**](SendSmtpEmailBcc.md) | Email addresses and names of the recipients in bcc | [optional]
9
9
  **cc** | [**Array<SendSmtpEmailCc>**](SendSmtpEmailCc.md) | Email addresses and names of the recipients in cc | [optional]
10
- **html_content** | **String** | HTML body of the message |
11
- **text_content** | **String** | Plain Text body of the message | [optional]
12
- **subject** | **String** | Subject of the message |
10
+ **html_content** | **String** | HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed ) | [optional]
11
+ **text_content** | **String** | Plain Text body of the message ( Ignored if 'templateId' is passed ) | [optional]
12
+ **subject** | **String** | Subject of the message. Mandatory if 'templateId' is not passed | [optional]
13
13
  **reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional]
14
- **attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment. Name can be used in both cases to define the attachment name. It is mandatory in case of content. Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional]
14
+ **attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment. Name can be used in both cases to define the attachment name. It is mandatory in case of content. Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps ( Ignored if 'templateId' is passed ) | [optional]
15
15
  **headers** | **Hash<String, String>** | | [optional]
16
+ **template_id** | **Integer** | Id of the template | [optional]
17
+ **params** | **Hash<String, String>** | | [optional]
16
18
 
17
19
 
data/docs/UpdateChild.md CHANGED
@@ -8,6 +8,5 @@ Name | Type | Description | Notes
8
8
  **last_name** | **String** | New Last name to use to update the child account | [optional]
9
9
  **company_name** | **String** | New Company name to use to update the child account | [optional]
10
10
  **password** | **String** | New password for the child account to login | [optional]
11
- **ips** | **Array<Integer>** | | [optional]
12
11
 
13
12
 
@@ -17,8 +17,8 @@ require 'sib-api-v3-sdk/version'
17
17
  require 'sib-api-v3-sdk/configuration'
18
18
 
19
19
  # Models
20
+ require 'sib-api-v3-sdk/models/add_contact_to_list'
20
21
  require 'sib-api-v3-sdk/models/add_credits'
21
- require 'sib-api-v3-sdk/models/add_remove_contact_to_list'
22
22
  require 'sib-api-v3-sdk/models/create_attribute'
23
23
  require 'sib-api-v3-sdk/models/create_attribute_enumeration'
24
24
  require 'sib-api-v3-sdk/models/create_child'
@@ -28,6 +28,7 @@ require 'sib-api-v3-sdk/models/create_email_campaign_recipients'
28
28
  require 'sib-api-v3-sdk/models/create_email_campaign_sender'
29
29
  require 'sib-api-v3-sdk/models/create_list'
30
30
  require 'sib-api-v3-sdk/models/create_model'
31
+ require 'sib-api-v3-sdk/models/create_reseller'
31
32
  require 'sib-api-v3-sdk/models/create_sender'
32
33
  require 'sib-api-v3-sdk/models/create_sender_ips'
33
34
  require 'sib-api-v3-sdk/models/create_sender_model'
@@ -54,8 +55,9 @@ require 'sib-api-v3-sdk/models/get_campaign_overview'
54
55
  require 'sib-api-v3-sdk/models/get_campaign_recipients'
55
56
  require 'sib-api-v3-sdk/models/get_campaign_stats'
56
57
  require 'sib-api-v3-sdk/models/get_child_info_api_keys'
58
+ require 'sib-api-v3-sdk/models/get_child_info_api_keys_v2'
59
+ require 'sib-api-v3-sdk/models/get_child_info_api_keys_v3'
57
60
  require 'sib-api-v3-sdk/models/get_child_info_credits'
58
- require 'sib-api-v3-sdk/models/get_child_info_ips'
59
61
  require 'sib-api-v3-sdk/models/get_child_info_statistics'
60
62
  require 'sib-api-v3-sdk/models/get_children_list'
61
63
  require 'sib-api-v3-sdk/models/get_client'
@@ -120,6 +122,7 @@ require 'sib-api-v3-sdk/models/post_send_sms_test_failed'
120
122
  require 'sib-api-v3-sdk/models/remaining_credit_model'
121
123
  require 'sib-api-v3-sdk/models/remaining_credit_model_child'
122
124
  require 'sib-api-v3-sdk/models/remaining_credit_model_reseller'
125
+ require 'sib-api-v3-sdk/models/remove_contact_from_list'
123
126
  require 'sib-api-v3-sdk/models/remove_credits'
124
127
  require 'sib-api-v3-sdk/models/request_contact_export'
125
128
  require 'sib-api-v3-sdk/models/request_contact_import'
@@ -1139,8 +1139,8 @@ module SibApiV3Sdk
1139
1139
  # @param contact_emails Emails adresses of the contact
1140
1140
  # @param [Hash] opts the optional parameters
1141
1141
  # @return [PostContactInfo]
1142
- def remove_contact_to_list(list_id, contact_emails, opts = {})
1143
- data, _status_code, _headers = remove_contact_to_list_with_http_info(list_id, contact_emails, opts)
1142
+ def remove_contact_from_list(list_id, contact_emails, opts = {})
1143
+ data, _status_code, _headers = remove_contact_from_list_with_http_info(list_id, contact_emails, opts)
1144
1144
  return data
1145
1145
  end
1146
1146
 
@@ -1150,17 +1150,17 @@ module SibApiV3Sdk
1150
1150
  # @param contact_emails Emails adresses of the contact
1151
1151
  # @param [Hash] opts the optional parameters
1152
1152
  # @return [Array<(PostContactInfo, Fixnum, Hash)>] PostContactInfo data, response status code and response headers
1153
- def remove_contact_to_list_with_http_info(list_id, contact_emails, opts = {})
1153
+ def remove_contact_from_list_with_http_info(list_id, contact_emails, opts = {})
1154
1154
  if @api_client.config.debugging
1155
- @api_client.config.logger.debug "Calling API: ContactsApi.remove_contact_to_list ..."
1155
+ @api_client.config.logger.debug "Calling API: ContactsApi.remove_contact_from_list ..."
1156
1156
  end
1157
1157
  # verify the required parameter 'list_id' is set
1158
1158
  if @api_client.config.client_side_validation && list_id.nil?
1159
- fail ArgumentError, "Missing the required parameter 'list_id' when calling ContactsApi.remove_contact_to_list"
1159
+ fail ArgumentError, "Missing the required parameter 'list_id' when calling ContactsApi.remove_contact_from_list"
1160
1160
  end
1161
1161
  # verify the required parameter 'contact_emails' is set
1162
1162
  if @api_client.config.client_side_validation && contact_emails.nil?
1163
- fail ArgumentError, "Missing the required parameter 'contact_emails' when calling ContactsApi.remove_contact_to_list"
1163
+ fail ArgumentError, "Missing the required parameter 'contact_emails' when calling ContactsApi.remove_contact_from_list"
1164
1164
  end
1165
1165
  # resource path
1166
1166
  local_var_path = "/contacts/lists/{listId}/contacts/remove".sub('{' + 'listId' + '}', list_id.to_s)
@@ -1189,7 +1189,7 @@ module SibApiV3Sdk
1189
1189
  :auth_names => auth_names,
1190
1190
  :return_type => 'PostContactInfo')
1191
1191
  if @api_client.config.debugging
1192
- @api_client.config.logger.debug "API called: ContactsApi#remove_contact_to_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1192
+ @api_client.config.logger.debug "API called: ContactsApi#remove_contact_from_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1193
1193
  end
1194
1194
  return data, status_code, headers
1195
1195
  end
@@ -443,8 +443,8 @@ module SibApiV3Sdk
443
443
  # @param contact_emails Emails adresses of the contact
444
444
  # @param [Hash] opts the optional parameters
445
445
  # @return [PostContactInfo]
446
- def remove_contact_to_list(list_id, contact_emails, opts = {})
447
- data, _status_code, _headers = remove_contact_to_list_with_http_info(list_id, contact_emails, opts)
446
+ def remove_contact_from_list(list_id, contact_emails, opts = {})
447
+ data, _status_code, _headers = remove_contact_from_list_with_http_info(list_id, contact_emails, opts)
448
448
  return data
449
449
  end
450
450
 
@@ -454,17 +454,17 @@ module SibApiV3Sdk
454
454
  # @param contact_emails Emails adresses of the contact
455
455
  # @param [Hash] opts the optional parameters
456
456
  # @return [Array<(PostContactInfo, Fixnum, Hash)>] PostContactInfo data, response status code and response headers
457
- def remove_contact_to_list_with_http_info(list_id, contact_emails, opts = {})
457
+ def remove_contact_from_list_with_http_info(list_id, contact_emails, opts = {})
458
458
  if @api_client.config.debugging
459
- @api_client.config.logger.debug "Calling API: ListsApi.remove_contact_to_list ..."
459
+ @api_client.config.logger.debug "Calling API: ListsApi.remove_contact_from_list ..."
460
460
  end
461
461
  # verify the required parameter 'list_id' is set
462
462
  if @api_client.config.client_side_validation && list_id.nil?
463
- fail ArgumentError, "Missing the required parameter 'list_id' when calling ListsApi.remove_contact_to_list"
463
+ fail ArgumentError, "Missing the required parameter 'list_id' when calling ListsApi.remove_contact_from_list"
464
464
  end
465
465
  # verify the required parameter 'contact_emails' is set
466
466
  if @api_client.config.client_side_validation && contact_emails.nil?
467
- fail ArgumentError, "Missing the required parameter 'contact_emails' when calling ListsApi.remove_contact_to_list"
467
+ fail ArgumentError, "Missing the required parameter 'contact_emails' when calling ListsApi.remove_contact_from_list"
468
468
  end
469
469
  # resource path
470
470
  local_var_path = "/contacts/lists/{listId}/contacts/remove".sub('{' + 'listId' + '}', list_id.to_s)
@@ -493,7 +493,7 @@ module SibApiV3Sdk
493
493
  :auth_names => auth_names,
494
494
  :return_type => 'PostContactInfo')
495
495
  if @api_client.config.debugging
496
- @api_client.config.logger.debug "API called: ListsApi#remove_contact_to_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
496
+ @api_client.config.logger.debug "API called: ListsApi#remove_contact_from_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
497
497
  end
498
498
  return data, status_code, headers
499
499
  end
@@ -22,35 +22,35 @@ module SibApiV3Sdk
22
22
 
23
23
  # Add Email and/or SMS credits to a specific child account
24
24
  #
25
- # @param child_id id of reseller&#39;s child
25
+ # @param child_auth_key auth key of reseller&#39;s child
26
26
  # @param add_credits Values to post to add credit to a specific child account
27
27
  # @param [Hash] opts the optional parameters
28
28
  # @return [RemainingCreditModel]
29
- def add_credits(child_id, add_credits, opts = {})
30
- data, _status_code, _headers = add_credits_with_http_info(child_id, add_credits, opts)
29
+ def add_credits(child_auth_key, add_credits, opts = {})
30
+ data, _status_code, _headers = add_credits_with_http_info(child_auth_key, add_credits, opts)
31
31
  return data
32
32
  end
33
33
 
34
34
  # Add Email and/or SMS credits to a specific child account
35
35
  #
36
- # @param child_id id of reseller&#39;s child
36
+ # @param child_auth_key auth key of reseller&#39;s child
37
37
  # @param add_credits Values to post to add credit to a specific child account
38
38
  # @param [Hash] opts the optional parameters
39
39
  # @return [Array<(RemainingCreditModel, Fixnum, Hash)>] RemainingCreditModel data, response status code and response headers
40
- def add_credits_with_http_info(child_id, add_credits, opts = {})
40
+ def add_credits_with_http_info(child_auth_key, add_credits, opts = {})
41
41
  if @api_client.config.debugging
42
42
  @api_client.config.logger.debug "Calling API: ResellerApi.add_credits ..."
43
43
  end
44
- # verify the required parameter 'child_id' is set
45
- if @api_client.config.client_side_validation && child_id.nil?
46
- fail ArgumentError, "Missing the required parameter 'child_id' when calling ResellerApi.add_credits"
44
+ # verify the required parameter 'child_auth_key' is set
45
+ if @api_client.config.client_side_validation && child_auth_key.nil?
46
+ fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.add_credits"
47
47
  end
48
48
  # verify the required parameter 'add_credits' is set
49
49
  if @api_client.config.client_side_validation && add_credits.nil?
50
50
  fail ArgumentError, "Missing the required parameter 'add_credits' when calling ResellerApi.add_credits"
51
51
  end
52
52
  # resource path
53
- local_var_path = "/reseller/children/{childId}/credits/add".sub('{' + 'childId' + '}', child_id.to_s)
53
+ local_var_path = "/reseller/children/{childAuthKey}/credits/add".sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
54
54
 
55
55
  # query parameters
56
56
  query_params = {}
@@ -83,35 +83,35 @@ module SibApiV3Sdk
83
83
 
84
84
  # Associate a dedicated IP to the child
85
85
  #
86
- # @param child_id id of reseller&#39;s child
87
- # @param ip_id IP&#39;s id
86
+ # @param child_auth_key auth key of reseller&#39;s child
87
+ # @param ip IP to associate
88
88
  # @param [Hash] opts the optional parameters
89
89
  # @return [nil]
90
- def associate_ip_to_child(child_id, ip_id, opts = {})
91
- associate_ip_to_child_with_http_info(child_id, ip_id, opts)
90
+ def associate_ip_to_child(child_auth_key, ip, opts = {})
91
+ associate_ip_to_child_with_http_info(child_auth_key, ip, opts)
92
92
  return nil
93
93
  end
94
94
 
95
95
  # Associate a dedicated IP to the child
96
96
  #
97
- # @param child_id id of reseller&#39;s child
98
- # @param ip_id IP&#39;s id
97
+ # @param child_auth_key auth key of reseller&#39;s child
98
+ # @param ip IP to associate
99
99
  # @param [Hash] opts the optional parameters
100
100
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
101
- def associate_ip_to_child_with_http_info(child_id, ip_id, opts = {})
101
+ def associate_ip_to_child_with_http_info(child_auth_key, ip, opts = {})
102
102
  if @api_client.config.debugging
103
103
  @api_client.config.logger.debug "Calling API: ResellerApi.associate_ip_to_child ..."
104
104
  end
105
- # verify the required parameter 'child_id' is set
106
- if @api_client.config.client_side_validation && child_id.nil?
107
- fail ArgumentError, "Missing the required parameter 'child_id' when calling ResellerApi.associate_ip_to_child"
105
+ # verify the required parameter 'child_auth_key' is set
106
+ if @api_client.config.client_side_validation && child_auth_key.nil?
107
+ fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.associate_ip_to_child"
108
108
  end
109
- # verify the required parameter 'ip_id' is set
110
- if @api_client.config.client_side_validation && ip_id.nil?
111
- fail ArgumentError, "Missing the required parameter 'ip_id' when calling ResellerApi.associate_ip_to_child"
109
+ # verify the required parameter 'ip' is set
110
+ if @api_client.config.client_side_validation && ip.nil?
111
+ fail ArgumentError, "Missing the required parameter 'ip' when calling ResellerApi.associate_ip_to_child"
112
112
  end
113
113
  # resource path
114
- local_var_path = "/reseller/children/{childId}/ips/associate".sub('{' + 'childId' + '}', child_id.to_s)
114
+ local_var_path = "/reseller/children/{childAuthKey}/ips/associate".sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
115
115
 
116
116
  # query parameters
117
117
  query_params = {}
@@ -127,7 +127,7 @@ module SibApiV3Sdk
127
127
  form_params = {}
128
128
 
129
129
  # http body (model)
130
- post_body = @api_client.object_to_http_body(ip_id)
130
+ post_body = @api_client.object_to_http_body(ip)
131
131
  auth_names = ['api-key']
132
132
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
133
133
  :header_params => header_params,
@@ -145,7 +145,7 @@ module SibApiV3Sdk
145
145
  #
146
146
  # @param [Hash] opts the optional parameters
147
147
  # @option opts [CreateChild] :reseller_child reseller child to add
148
- # @return [CreateModel]
148
+ # @return [CreateReseller]
149
149
  def create_reseller_child(opts = {})
150
150
  data, _status_code, _headers = create_reseller_child_with_http_info(opts)
151
151
  return data
@@ -155,7 +155,7 @@ module SibApiV3Sdk
155
155
  #
156
156
  # @param [Hash] opts the optional parameters
157
157
  # @option opts [CreateChild] :reseller_child reseller child to add
158
- # @return [Array<(CreateModel, Fixnum, Hash)>] CreateModel data, response status code and response headers
158
+ # @return [Array<(CreateReseller, Fixnum, Hash)>] CreateReseller data, response status code and response headers
159
159
  def create_reseller_child_with_http_info(opts = {})
160
160
  if @api_client.config.debugging
161
161
  @api_client.config.logger.debug "Calling API: ResellerApi.create_reseller_child ..."
@@ -185,38 +185,38 @@ module SibApiV3Sdk
185
185
  :form_params => form_params,
186
186
  :body => post_body,
187
187
  :auth_names => auth_names,
188
- :return_type => 'CreateModel')
188
+ :return_type => 'CreateReseller')
189
189
  if @api_client.config.debugging
190
190
  @api_client.config.logger.debug "API called: ResellerApi#create_reseller_child\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
191
191
  end
192
192
  return data, status_code, headers
193
193
  end
194
194
 
195
- # Deletes a single reseller child based on the childId supplied
195
+ # Deletes a single reseller child based on the childAuthKey supplied
196
196
  #
197
- # @param child_id id of reseller&#39;s child
197
+ # @param child_auth_key auth key of reseller&#39;s child
198
198
  # @param [Hash] opts the optional parameters
199
199
  # @return [nil]
200
- def delete_reseller_child(child_id, opts = {})
201
- delete_reseller_child_with_http_info(child_id, opts)
200
+ def delete_reseller_child(child_auth_key, opts = {})
201
+ delete_reseller_child_with_http_info(child_auth_key, opts)
202
202
  return nil
203
203
  end
204
204
 
205
- # Deletes a single reseller child based on the childId supplied
205
+ # Deletes a single reseller child based on the childAuthKey supplied
206
206
  #
207
- # @param child_id id of reseller&#39;s child
207
+ # @param child_auth_key auth key of reseller&#39;s child
208
208
  # @param [Hash] opts the optional parameters
209
209
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
210
- def delete_reseller_child_with_http_info(child_id, opts = {})
210
+ def delete_reseller_child_with_http_info(child_auth_key, opts = {})
211
211
  if @api_client.config.debugging
212
212
  @api_client.config.logger.debug "Calling API: ResellerApi.delete_reseller_child ..."
213
213
  end
214
- # verify the required parameter 'child_id' is set
215
- if @api_client.config.client_side_validation && child_id.nil?
216
- fail ArgumentError, "Missing the required parameter 'child_id' when calling ResellerApi.delete_reseller_child"
214
+ # verify the required parameter 'child_auth_key' is set
215
+ if @api_client.config.client_side_validation && child_auth_key.nil?
216
+ fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.delete_reseller_child"
217
217
  end
218
218
  # resource path
219
- local_var_path = "/reseller/children/{childId}".sub('{' + 'childId' + '}', child_id.to_s)
219
+ local_var_path = "/reseller/children/{childAuthKey}".sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
220
220
 
221
221
  # query parameters
222
222
  query_params = {}
@@ -248,35 +248,35 @@ module SibApiV3Sdk
248
248
 
249
249
  # Dissociate a dedicated IP to the child
250
250
  #
251
- # @param child_id id of reseller&#39;s child
252
- # @param ip_id IP&#39;s id
251
+ # @param child_auth_key auth key of reseller&#39;s child
252
+ # @param ip IP to dissociate
253
253
  # @param [Hash] opts the optional parameters
254
254
  # @return [nil]
255
- def dissociate_ip_from_child(child_id, ip_id, opts = {})
256
- dissociate_ip_from_child_with_http_info(child_id, ip_id, opts)
255
+ def dissociate_ip_from_child(child_auth_key, ip, opts = {})
256
+ dissociate_ip_from_child_with_http_info(child_auth_key, ip, opts)
257
257
  return nil
258
258
  end
259
259
 
260
260
  # Dissociate a dedicated IP to the child
261
261
  #
262
- # @param child_id id of reseller&#39;s child
263
- # @param ip_id IP&#39;s id
262
+ # @param child_auth_key auth key of reseller&#39;s child
263
+ # @param ip IP to dissociate
264
264
  # @param [Hash] opts the optional parameters
265
265
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
266
- def dissociate_ip_from_child_with_http_info(child_id, ip_id, opts = {})
266
+ def dissociate_ip_from_child_with_http_info(child_auth_key, ip, opts = {})
267
267
  if @api_client.config.debugging
268
268
  @api_client.config.logger.debug "Calling API: ResellerApi.dissociate_ip_from_child ..."
269
269
  end
270
- # verify the required parameter 'child_id' is set
271
- if @api_client.config.client_side_validation && child_id.nil?
272
- fail ArgumentError, "Missing the required parameter 'child_id' when calling ResellerApi.dissociate_ip_from_child"
270
+ # verify the required parameter 'child_auth_key' is set
271
+ if @api_client.config.client_side_validation && child_auth_key.nil?
272
+ fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.dissociate_ip_from_child"
273
273
  end
274
- # verify the required parameter 'ip_id' is set
275
- if @api_client.config.client_side_validation && ip_id.nil?
276
- fail ArgumentError, "Missing the required parameter 'ip_id' when calling ResellerApi.dissociate_ip_from_child"
274
+ # verify the required parameter 'ip' is set
275
+ if @api_client.config.client_side_validation && ip.nil?
276
+ fail ArgumentError, "Missing the required parameter 'ip' when calling ResellerApi.dissociate_ip_from_child"
277
277
  end
278
278
  # resource path
279
- local_var_path = "/reseller/children/{childId}/ips/dissociate".sub('{' + 'childId' + '}', child_id.to_s)
279
+ local_var_path = "/reseller/children/{childAuthKey}/ips/dissociate".sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
280
280
 
281
281
  # query parameters
282
282
  query_params = {}
@@ -292,7 +292,7 @@ module SibApiV3Sdk
292
292
  form_params = {}
293
293
 
294
294
  # http body (model)
295
- post_body = @api_client.object_to_http_body(ip_id)
295
+ post_body = @api_client.object_to_http_body(ip)
296
296
  auth_names = ['api-key']
297
297
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
298
298
  :header_params => header_params,
@@ -308,29 +308,29 @@ module SibApiV3Sdk
308
308
 
309
309
  # Gets the info about a specific child account
310
310
  #
311
- # @param child_id id of reseller&#39;s child
311
+ # @param child_auth_key auth key of reseller&#39;s child
312
312
  # @param [Hash] opts the optional parameters
313
313
  # @return [GetChildInfo]
314
- def get_child_info(child_id, opts = {})
315
- data, _status_code, _headers = get_child_info_with_http_info(child_id, opts)
314
+ def get_child_info(child_auth_key, opts = {})
315
+ data, _status_code, _headers = get_child_info_with_http_info(child_auth_key, opts)
316
316
  return data
317
317
  end
318
318
 
319
319
  # Gets the info about a specific child account
320
320
  #
321
- # @param child_id id of reseller&#39;s child
321
+ # @param child_auth_key auth key of reseller&#39;s child
322
322
  # @param [Hash] opts the optional parameters
323
323
  # @return [Array<(GetChildInfo, Fixnum, Hash)>] GetChildInfo data, response status code and response headers
324
- def get_child_info_with_http_info(child_id, opts = {})
324
+ def get_child_info_with_http_info(child_auth_key, opts = {})
325
325
  if @api_client.config.debugging
326
326
  @api_client.config.logger.debug "Calling API: ResellerApi.get_child_info ..."
327
327
  end
328
- # verify the required parameter 'child_id' is set
329
- if @api_client.config.client_side_validation && child_id.nil?
330
- fail ArgumentError, "Missing the required parameter 'child_id' when calling ResellerApi.get_child_info"
328
+ # verify the required parameter 'child_auth_key' is set
329
+ if @api_client.config.client_side_validation && child_auth_key.nil?
330
+ fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.get_child_info"
331
331
  end
332
332
  # resource path
333
- local_var_path = "/reseller/children/{childId}".sub('{' + 'childId' + '}', child_id.to_s)
333
+ local_var_path = "/reseller/children/{childAuthKey}".sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
334
334
 
335
335
  # query parameters
336
336
  query_params = {}
@@ -412,35 +412,35 @@ module SibApiV3Sdk
412
412
 
413
413
  # Remove Email and/or SMS credits from a specific child account
414
414
  #
415
- # @param child_id id of reseller&#39;s child
415
+ # @param child_auth_key auth key of reseller&#39;s child
416
416
  # @param remove_credits Values to post to remove email or SMS credits from a specific child account
417
417
  # @param [Hash] opts the optional parameters
418
418
  # @return [RemainingCreditModel]
419
- def remove_credits(child_id, remove_credits, opts = {})
420
- data, _status_code, _headers = remove_credits_with_http_info(child_id, remove_credits, opts)
419
+ def remove_credits(child_auth_key, remove_credits, opts = {})
420
+ data, _status_code, _headers = remove_credits_with_http_info(child_auth_key, remove_credits, opts)
421
421
  return data
422
422
  end
423
423
 
424
424
  # Remove Email and/or SMS credits from a specific child account
425
425
  #
426
- # @param child_id id of reseller&#39;s child
426
+ # @param child_auth_key auth key of reseller&#39;s child
427
427
  # @param remove_credits Values to post to remove email or SMS credits from a specific child account
428
428
  # @param [Hash] opts the optional parameters
429
429
  # @return [Array<(RemainingCreditModel, Fixnum, Hash)>] RemainingCreditModel data, response status code and response headers
430
- def remove_credits_with_http_info(child_id, remove_credits, opts = {})
430
+ def remove_credits_with_http_info(child_auth_key, remove_credits, opts = {})
431
431
  if @api_client.config.debugging
432
432
  @api_client.config.logger.debug "Calling API: ResellerApi.remove_credits ..."
433
433
  end
434
- # verify the required parameter 'child_id' is set
435
- if @api_client.config.client_side_validation && child_id.nil?
436
- fail ArgumentError, "Missing the required parameter 'child_id' when calling ResellerApi.remove_credits"
434
+ # verify the required parameter 'child_auth_key' is set
435
+ if @api_client.config.client_side_validation && child_auth_key.nil?
436
+ fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.remove_credits"
437
437
  end
438
438
  # verify the required parameter 'remove_credits' is set
439
439
  if @api_client.config.client_side_validation && remove_credits.nil?
440
440
  fail ArgumentError, "Missing the required parameter 'remove_credits' when calling ResellerApi.remove_credits"
441
441
  end
442
442
  # resource path
443
- local_var_path = "/reseller/children/{childId}/credits/remove".sub('{' + 'childId' + '}', child_id.to_s)
443
+ local_var_path = "/reseller/children/{childAuthKey}/credits/remove".sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
444
444
 
445
445
  # query parameters
446
446
  query_params = {}
@@ -471,37 +471,37 @@ module SibApiV3Sdk
471
471
  return data, status_code, headers
472
472
  end
473
473
 
474
- # Updates infos of reseller's child based on the childId supplied
474
+ # Updates infos of reseller's child based on the childAuthKey supplied
475
475
  #
476
- # @param child_id id of reseller&#39;s child
476
+ # @param child_auth_key auth key of reseller&#39;s child
477
477
  # @param reseller_child values to update in child profile
478
478
  # @param [Hash] opts the optional parameters
479
479
  # @return [nil]
480
- def update_reseller_child(child_id, reseller_child, opts = {})
481
- update_reseller_child_with_http_info(child_id, reseller_child, opts)
480
+ def update_reseller_child(child_auth_key, reseller_child, opts = {})
481
+ update_reseller_child_with_http_info(child_auth_key, reseller_child, opts)
482
482
  return nil
483
483
  end
484
484
 
485
- # Updates infos of reseller&#39;s child based on the childId supplied
485
+ # Updates infos of reseller&#39;s child based on the childAuthKey supplied
486
486
  #
487
- # @param child_id id of reseller&#39;s child
487
+ # @param child_auth_key auth key of reseller&#39;s child
488
488
  # @param reseller_child values to update in child profile
489
489
  # @param [Hash] opts the optional parameters
490
490
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
491
- def update_reseller_child_with_http_info(child_id, reseller_child, opts = {})
491
+ def update_reseller_child_with_http_info(child_auth_key, reseller_child, opts = {})
492
492
  if @api_client.config.debugging
493
493
  @api_client.config.logger.debug "Calling API: ResellerApi.update_reseller_child ..."
494
494
  end
495
- # verify the required parameter 'child_id' is set
496
- if @api_client.config.client_side_validation && child_id.nil?
497
- fail ArgumentError, "Missing the required parameter 'child_id' when calling ResellerApi.update_reseller_child"
495
+ # verify the required parameter 'child_auth_key' is set
496
+ if @api_client.config.client_side_validation && child_auth_key.nil?
497
+ fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.update_reseller_child"
498
498
  end
499
499
  # verify the required parameter 'reseller_child' is set
500
500
  if @api_client.config.client_side_validation && reseller_child.nil?
501
501
  fail ArgumentError, "Missing the required parameter 'reseller_child' when calling ResellerApi.update_reseller_child"
502
502
  end
503
503
  # resource path
504
- local_var_path = "/reseller/children/{childId}".sub('{' + 'childId' + '}', child_id.to_s)
504
+ local_var_path = "/reseller/children/{childAuthKey}".sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
505
505
 
506
506
  # query parameters
507
507
  query_params = {}