sib-api-v3-sdk 5.2.3 → 5.5.0

data/spec/api/reseller_api_spec.rb

@@ -1,12 +1,12 @@
 =begin
 #SendinBlue API
 
-#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/sendinblue  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  | 
+#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/sendinblue  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  | 
 
 OpenAPI spec version: 3.0.0
 Contact: contact@sendinblue.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Swagger Codegen version: 2.4.12
 
 =end
 
@@ -34,176 +34,188 @@ describe 'ResellerApi' do
 
   # unit tests for add_credits
   # Add Email and/or SMS credits to a specific child account
-  # 
-  # @param child_auth_key auth key of reseller's child
+  # @param child_identifier Either auth key or id of reseller's child
   # @param add_credits Values to post to add credit to a specific child account
   # @param [Hash] opts the optional parameters
   # @return [RemainingCreditModel]
   describe 'add_credits test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for associate_ip_to_child
   # Associate a dedicated IP to the child
-  # 
-  # @param child_auth_key auth key of reseller's child
+  # @param child_identifier Either auth key or id of reseller's child
   # @param ip IP to associate
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'associate_ip_to_child test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for create_child_domain
-  # Creates a domain for a child account
-  # 
-  # @param child_auth_key auth key of reseller's child
-  # @param add_child_domain Sender domain to add for a specific child account
+  # Create a domain for a child account
+  # @param child_identifier Either auth key or id of reseller's child
+  # @param add_child_domain Sender domain to add for a specific child account. This will not be displayed to the parent account.
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'create_child_domain test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for create_reseller_child
   # Creates a reseller child
-  # 
   # @param [Hash] opts the optional parameters
   # @option opts [CreateChild] :reseller_child reseller child to add
   # @return [CreateReseller]
   describe 'create_reseller_child test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for delete_child_domain
-  # Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed
-  # 
-  # @param child_auth_key auth key of reseller's child
+  # Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
+  # @param child_identifier Either auth key or id of reseller's child
   # @param domain_name Pass the existing domain that needs to be deleted
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'delete_child_domain test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for delete_reseller_child
-  # Deletes a single reseller child based on the childAuthKey supplied
-  # 
-  # @param child_auth_key auth key of reseller's child
+  # Delete a single reseller child based on the child identifier supplied
+  # @param child_identifier Either auth key or child id of reseller's child
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'delete_reseller_child test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for dissociate_ip_from_child
   # Dissociate a dedicated IP to the child
-  # 
-  # @param child_auth_key auth key of reseller's child
+  # @param child_identifier Either auth key or id of reseller's child
   # @param ip IP to dissociate
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'dissociate_ip_from_child test' do
-    it "should work" do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_child_account_creation_status
+  # Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied
+  # @param child_identifier Either auth key or id of reseller's child
+  # @param [Hash] opts the optional parameters
+  # @return [GetChildAccountCreationStatus]
+  describe 'get_child_account_creation_status test' do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for get_child_domains
-  # Gets all the sender domains of a specific child account
-  # 
-  # @param child_auth_key auth key of reseller's child
+  # Get all sender domains for a specific child account
+  # @param child_identifier Either auth key or id of reseller's child
   # @param [Hash] opts the optional parameters
   # @return [GetChildDomains]
   describe 'get_child_domains test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for get_child_info
-  # Gets the info about a specific child account
-  # 
-  # @param child_auth_key auth key of reseller's child
+  # Get a child account's details
+  # @param child_identifier Either auth key or id of reseller's child
   # @param [Hash] opts the optional parameters
   # @return [GetChildInfo]
   describe 'get_child_info test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for get_reseller_childs
-  # Gets the list of all reseller's children accounts
-  # 
+  # Get the list of all children accounts
   # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit Number of documents for child accounts information per page
+  # @option opts [Integer] :offset Index of the first document in the page
   # @return [GetChildrenList]
   describe 'get_reseller_childs test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for get_sso_token
-  # Generates a session token which will remain valid for a short period of time only.
-  # 
-  # @param child_auth_key auth key of reseller's child
+  # Get session token to access Sendinblue (SSO)
+  # It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token]
+  # @param child_identifier Either auth key or id of reseller's child
   # @param [Hash] opts the optional parameters
   # @return [GetSsoToken]
   describe 'get_sso_token test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for remove_credits
   # Remove Email and/or SMS credits from a specific child account
-  # 
-  # @param child_auth_key auth key of reseller's child
+  # @param child_identifier Either auth key or id of reseller's child
   # @param remove_credits Values to post to remove email or SMS credits from a specific child account
   # @param [Hash] opts the optional parameters
   # @return [RemainingCreditModel]
   describe 'remove_credits test' do
-    it "should work" do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_child_account_status
+  # Update info of reseller's child account status based on the childIdentifier supplied
+  # @param child_identifier Either auth key or id of reseller's child
+  # @param update_child_account_status values to update in child account status
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_child_account_status test' do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for update_child_domain
-  # Updates the sender domain of reseller's child based on the childAuthKey and domainName passed
-  # 
-  # @param child_auth_key auth key of reseller's child
+  # Update the sender domain of reseller's child based on the childIdentifier and domainName passed
+  # @param child_identifier Either auth key or id of reseller's child
   # @param domain_name Pass the existing domain that needs to be updated
   # @param update_child_domain value to update for sender domain
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'update_child_domain test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for update_reseller_child
-  # Updates infos of reseller's child based on the childAuthKey supplied
-  # 
-  # @param child_auth_key auth key of reseller's child
+  # Update info of reseller's child based on the child identifier supplied
+  # @param child_identifier Either auth key or id of reseller's child
   # @param reseller_child values to update in child profile
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'update_reseller_child test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end

data/spec/api/senders_api_spec.rb

@@ -1,12 +1,12 @@
 =begin
 #SendinBlue API
 
-#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/sendinblue  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  | 
+#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/sendinblue  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  | 
 
 OpenAPI spec version: 3.0.0
 Contact: contact@sendinblue.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Swagger Codegen version: 2.4.12
 
 =end
 
@@ -34,73 +34,67 @@ describe 'SendersApi' do
 
   # unit tests for create_sender
   # Create a new sender
-  # 
   # @param [Hash] opts the optional parameters
   # @option opts [CreateSender] :sender sender's name
   # @return [CreateSenderModel]
   describe 'create_sender test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for delete_sender
   # Delete a sender
-  # 
   # @param sender_id Id of the sender
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'delete_sender test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for get_ips
-  # Return all the dedicated IPs for your account
-  # 
+  # Get all the dedicated IPs for your account
   # @param [Hash] opts the optional parameters
   # @return [GetIps]
   describe 'get_ips test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for get_ips_from_sender
-  # Return all the dedicated IPs for a sender
-  # 
+  # Get all the dedicated IPs for a sender
   # @param sender_id Id of the sender
   # @param [Hash] opts the optional parameters
   # @return [GetIpsFromSender]
   describe 'get_ips_from_sender test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for get_senders
   # Get the list of all your senders
-  # 
   # @param [Hash] opts the optional parameters
   # @option opts [String] :ip Filter your senders for a specific ip (available for dedicated IP usage only)
   # @option opts [String] :domain Filter your senders for a specific domain
   # @return [GetSendersList]
   describe 'get_senders test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for update_sender
   # Update a sender
-  # 
   # @param sender_id Id of the sender
   # @param [Hash] opts the optional parameters
   # @option opts [UpdateSender] :sender sender's name
   # @return [nil]
   describe 'update_sender test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end

data/spec/api/sms_campaigns_api_spec.rb

@@ -1,12 +1,12 @@
 =begin
 #SendinBlue API
 
-#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/sendinblue  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  | 
+#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/sendinblue  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  | 
 
 OpenAPI spec version: 3.0.0
 Contact: contact@sendinblue.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Swagger Codegen version: 2.4.12
 
 =end
 
@@ -34,43 +34,39 @@ describe 'SMSCampaignsApi' do
 
   # unit tests for create_sms_campaign
   # Creates an SMS campaign
-  # 
   # @param create_sms_campaign Values to create an SMS Campaign
   # @param [Hash] opts the optional parameters
   # @return [CreateModel]
   describe 'create_sms_campaign test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for delete_sms_campaign
-  # Delete the SMS campaign
-  # 
+  # Delete an SMS campaign
   # @param campaign_id id of the SMS campaign
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'delete_sms_campaign test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for get_sms_campaign
   # Get an SMS campaign
-  # 
   # @param campaign_id id of the SMS campaign
   # @param [Hash] opts the optional parameters
   # @return [GetSmsCampaign]
   describe 'get_sms_campaign test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for get_sms_campaigns
-  # Returns the informations for all your created SMS campaigns
-  # 
+  # Returns the information for all your created SMS campaigns
   # @param [Hash] opts the optional parameters
   # @option opts [String] :status Status of campaign.
   # @option opts [DateTime] :start_date Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
@@ -79,84 +75,80 @@ describe 'SMSCampaignsApi' do
   # @option opts [Integer] :offset Beginning point in the list to retrieve from.
   # @return [GetSmsCampaigns]
   describe 'get_sms_campaigns test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for request_sms_recipient_export
-  # Exports the recipients of the specified campaign.
+  # Export an SMS campaign's recipients
   # It returns the background process ID which on completion calls the notify URL that you have set in the input.
   # @param campaign_id id of the campaign
   # @param [Hash] opts the optional parameters
   # @option opts [RequestSmsRecipientExport] :recipient_export Values to send for a recipient export request
   # @return [CreatedProcessId]
   describe 'request_sms_recipient_export test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for send_sms_campaign_now
   # Send your SMS campaign immediately
-  # 
   # @param campaign_id id of the campaign
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'send_sms_campaign_now test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for send_sms_report
-  # Send report of SMS campaigns
+  # Send an SMS campaign's report
   # Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.
   # @param campaign_id id of the campaign
   # @param send_report Values for send a report
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'send_sms_report test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for send_test_sms
-  # Send an SMS
-  # 
+  # Send a test SMS campaign
   # @param campaign_id Id of the SMS campaign
   # @param phone_number Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'send_test_sms test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for update_sms_campaign
-  # Updates an SMS campaign
-  # 
+  # Update an SMS campaign
   # @param campaign_id id of the SMS campaign
   # @param update_sms_campaign Values to update an SMS Campaign
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'update_sms_campaign test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for update_sms_campaign_status
-  # Update the campaign status
-  # 
+  # Update a campaign's status
   # @param campaign_id id of the campaign
   # @param status Status of the campaign.
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'update_sms_campaign_status test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end