sib-api-v3-sdk 5.3.0 → 5.4.0

data/lib/sib-api-v3-sdk/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.12
 =end
 
 module SibApiV3Sdk
-  VERSION = "5.3.0"
+  VERSION = "5.4.0"
 end

data/sib-api-v3-sdk.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-#
+
 =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
 
@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.homepage    = "https://www.sendinblue.com/"
   s.summary     = "SendinBlue API V3 Ruby Gem"
   s.description = "Official SendinBlue provided RESTFul API V3 ruby library"
-  s.license     = "MIT"
+  s.license     = 'MIT'
   s.required_ruby_version = ">= 1.9"
 
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
@@ -38,7 +38,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
   s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
 
-  s.files         = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
   s.test_files    = `find spec/*`.split("\n")
   s.executables   = []
   s.require_paths = ["lib"]

data/spec/api/account_api_spec.rb

@@ -33,7 +33,7 @@ describe 'AccountApi' do
   end
 
   # unit tests for get_account
-  # Get your account informations, plans and credits details
+  # Get your account information, plan and credits details
   # @param [Hash] opts the optional parameters
   # @return [GetAccount]
   describe 'get_account test' do

data/spec/api/attributes_api_spec.rb

@@ -33,7 +33,7 @@ describe 'AttributesApi' do
   end
 
   # unit tests for create_attribute
-  # Creates contact attribute
+  # Create contact attribute
   # @param attribute_category Category of the attribute
   # @param attribute_name Name of the attribute
   # @param create_attribute Values to create an attribute
@@ -46,7 +46,7 @@ describe 'AttributesApi' do
   end
 
   # unit tests for delete_attribute
-  # Deletes an attribute
+  # Delete an attribute
   # @param attribute_category Category of the attribute
   # @param attribute_name Name of the existing attribute
   # @param [Hash] opts the optional parameters
@@ -58,7 +58,7 @@ describe 'AttributesApi' do
   end
 
   # unit tests for get_attributes
-  # Lists all attributes
+  # List all attributes
   # @param [Hash] opts the optional parameters
   # @return [GetAttributes]
   describe 'get_attributes test' do
@@ -68,7 +68,7 @@ describe 'AttributesApi' do
   end
 
   # unit tests for update_attribute
-  # Updates contact attribute
+  # Update contact attribute
   # @param attribute_category Category of the attribute
   # @param attribute_name Name of the existing attribute
   # @param update_attribute Values to update an attribute

data/spec/api/contacts_api_spec.rb

@@ -45,7 +45,7 @@ describe 'ContactsApi' do
   end
 
   # unit tests for create_attribute
-  # Creates contact attribute
+  # Create contact attribute
   # @param attribute_category Category of the attribute
   # @param attribute_name Name of the attribute
   # @param create_attribute Values to create an attribute
@@ -68,6 +68,17 @@ describe 'ContactsApi' do
     end
   end
 
+  # unit tests for create_doi_contact
+  # Create a contact to trigger the DOI workflow from a Landing Page form
+  # @param create_doi_contact Values to create the DOI contact
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'create_doi_contact 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 create_folder
   # Create a folder
   # @param create_folder Name of the folder
@@ -91,7 +102,7 @@ describe 'ContactsApi' do
   end
 
   # unit tests for delete_attribute
-  # Deletes an attribute
+  # Delete an attribute
   # @param attribute_category Category of the attribute
   # @param attribute_name Name of the existing attribute
   # @param [Hash] opts the optional parameters
@@ -103,7 +114,7 @@ describe 'ContactsApi' do
   end
 
   # unit tests for delete_contact
-  # Deletes a contact
+  # Delete a contact
   # @param email Email (urlencoded) of the contact
   # @param [Hash] opts the optional parameters
   # @return [nil]
@@ -136,7 +147,7 @@ describe 'ContactsApi' do
   end
 
   # unit tests for get_attributes
-  # Lists all attributes
+  # List all attributes
   # @param [Hash] opts the optional parameters
   # @return [GetAttributes]
   describe 'get_attributes test' do
@@ -146,7 +157,7 @@ describe 'ContactsApi' do
   end
 
   # unit tests for get_contact_info
-  # Retrieves contact informations
+  # Get a contact's details
   # @param email Email (urlencoded) of the contact OR its SMS attribute value
   # @param [Hash] opts the optional parameters
   # @return [GetExtendedContactDetails]
@@ -157,9 +168,11 @@ describe 'ContactsApi' do
   end
 
   # unit tests for get_contact_stats
-  # Get the campaigns statistics for a contact
+  # Get email campaigns' statistics for a contact
   # @param email Email address (urlencoded) of the contact
   # @param [Hash] opts the optional parameters
+  # @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
+  # @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
   # @return [GetContactCampaignStats]
   describe 'get_contact_stats test' do
     it 'should work' do
@@ -181,7 +194,7 @@ describe 'ContactsApi' do
   end
 
   # unit tests for get_contacts_from_list
-  # Get the contacts in a list
+  # Get contacts in a list
   # @param list_id Id of the list
   # @param [Hash] opts the optional parameters
   # @option opts [DateTime] :modified_since Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
@@ -195,7 +208,7 @@ describe 'ContactsApi' do
   end
 
   # unit tests for get_folder
-  # Returns folder details
+  # Returns a folder's details
   # @param folder_id id of the folder
   # @param [Hash] opts the optional parameters
   # @return [GetFolder]
@@ -206,7 +219,7 @@ describe 'ContactsApi' do
   end
 
   # unit tests for get_folder_lists
-  # Get the lists in a folder
+  # Get lists in a folder
   # @param folder_id Id of the folder
   # @param [Hash] opts the optional parameters
   # @option opts [Integer] :limit Number of documents per page
@@ -219,7 +232,7 @@ describe 'ContactsApi' do
   end
 
   # unit tests for get_folders
-  # Get all the folders
+  # Get all folders
   # @param limit Number of documents per page
   # @param offset Index of the first document of the page
   # @param [Hash] opts the optional parameters
@@ -231,7 +244,7 @@ describe 'ContactsApi' do
   end
 
   # unit tests for get_list
-  # Get the details of a list
+  # Get a list's details
   # @param list_id Id of the list
   # @param [Hash] opts the optional parameters
   # @return [GetExtendedList]
@@ -266,7 +279,7 @@ describe 'ContactsApi' do
   end
 
   # unit tests for remove_contact_from_list
-  # Remove existing contacts from a list
+  # Delete a contact from a list
   # @param list_id Id of the list
   # @param contact_emails Emails adresses of the contact
   # @param [Hash] opts the optional parameters
@@ -290,7 +303,7 @@ describe 'ContactsApi' do
   end
 
   # unit tests for update_attribute
-  # Updates contact attribute
+  # Update contact attribute
   # @param attribute_category Category of the attribute
   # @param attribute_name Name of the existing attribute
   # @param update_attribute Values to update an attribute
@@ -303,7 +316,7 @@ describe 'ContactsApi' do
   end
 
   # unit tests for update_contact
-  # Updates a contact
+  # Update a contact
   # @param email Email (urlencoded) of the contact
   # @param update_contact Values to update a contact
   # @param [Hash] opts the optional parameters
@@ -315,7 +328,7 @@ describe 'ContactsApi' do
   end
 
   # unit tests for update_folder
-  # Update a contact folder
+  # Update a folder
   # @param folder_id Id of the folder
   # @param update_folder Name of the folder
   # @param [Hash] opts the optional parameters

data/spec/api/email_campaigns_api_spec.rb

@@ -55,7 +55,7 @@ describe 'EmailCampaignsApi' do
   end
 
   # unit tests for email_export_recipients
-  # Export the recipients of a campaign
+  # Export the recipients of an email campaign
   # @param campaign_id Id of the campaign
   # @param [Hash] opts the optional parameters
   # @option opts [EmailExportRecipients] :recipient_export Values to send for a recipient export request
@@ -67,7 +67,7 @@ describe 'EmailCampaignsApi' do
   end
 
   # unit tests for get_ab_test_campaign_result
-  # Get A/B test email campaign result
+  # Get an A/B test email campaign results
   # Obtain winning version of an A/B test email campaign
   # @param campaign_id Id of the A/B test campaign
   # @param [Hash] opts the optional parameters
@@ -79,7 +79,7 @@ describe 'EmailCampaignsApi' do
   end
 
   # unit tests for get_email_campaign
-  # Get campaign informations
+  # Get an email campaign report
   # @param campaign_id Id of the campaign
   # @param [Hash] opts the optional parameters
   # @return [GetEmailCampaign]
@@ -90,7 +90,7 @@ describe 'EmailCampaignsApi' do
   end
 
   # unit tests for get_email_campaigns
-  # Return all your created campaigns
+  # Return all your created email campaigns
   # @param [Hash] opts the optional parameters
   # @option opts [String] :type Filter on the type of the campaigns
   # @option opts [String] :status Filter on the status of the campaign
@@ -129,7 +129,7 @@ describe 'EmailCampaignsApi' do
   end
 
   # unit tests for send_report
-  # Send the report of a campaigns
+  # Send the report of a campaign
   # A PDF will be sent to the specified email addresses
   # @param campaign_id Id of the campaign
   # @param send_report Values for send a report
@@ -154,7 +154,7 @@ describe 'EmailCampaignsApi' do
   end
 
   # unit tests for update_campaign_status
-  # Update a campaign status
+  # Update an email campaign status
   # @param campaign_id Id of the campaign
   # @param status Status of the campaign
   # @param [Hash] opts the optional parameters
@@ -166,7 +166,7 @@ describe 'EmailCampaignsApi' do
   end
 
   # unit tests for update_email_campaign
-  # Update a campaign
+  # Update an email campaign
   # @param campaign_id Id of the campaign
   # @param email_campaign Values to update a campaign
   # @param [Hash] opts the optional parameters
@@ -177,4 +177,15 @@ describe 'EmailCampaignsApi' do
     end
   end
 
+  # unit tests for upload_image_to_gallery
+  # Upload an image to your account's image gallery
+  # @param upload_image Parameters to upload an image
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'upload_image_to_gallery test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

data/spec/api/folders_api_spec.rb

@@ -55,7 +55,7 @@ describe 'FoldersApi' do
   end
 
   # unit tests for get_folder
-  # Returns folder details
+  # Returns a folder's details
   # @param folder_id id of the folder
   # @param [Hash] opts the optional parameters
   # @return [GetFolder]
@@ -66,7 +66,7 @@ describe 'FoldersApi' do
   end
 
   # unit tests for get_folder_lists
-  # Get the lists in a folder
+  # Get lists in a folder
   # @param folder_id Id of the folder
   # @param [Hash] opts the optional parameters
   # @option opts [Integer] :limit Number of documents per page
@@ -79,7 +79,7 @@ describe 'FoldersApi' do
   end
 
   # unit tests for get_folders
-  # Get all the folders
+  # Get all folders
   # @param limit Number of documents per page
   # @param offset Index of the first document of the page
   # @param [Hash] opts the optional parameters
@@ -91,7 +91,7 @@ describe 'FoldersApi' do
   end
 
   # unit tests for update_folder
-  # Update a contact folder
+  # Update a folder
   # @param folder_id Id of the folder
   # @param update_folder Name of the folder
   # @param [Hash] opts the optional parameters

data/spec/api/lists_api_spec.rb

@@ -67,7 +67,7 @@ describe 'ListsApi' do
   end
 
   # unit tests for get_contacts_from_list
-  # Get the contacts in a list
+  # Get contacts in a list
   # @param list_id Id of the list
   # @param [Hash] opts the optional parameters
   # @option opts [DateTime] :modified_since Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
@@ -81,7 +81,7 @@ describe 'ListsApi' do
   end
 
   # unit tests for get_folder_lists
-  # Get the lists in a folder
+  # Get lists in a folder
   # @param folder_id Id of the folder
   # @param [Hash] opts the optional parameters
   # @option opts [Integer] :limit Number of documents per page
@@ -94,7 +94,7 @@ describe 'ListsApi' do
   end
 
   # unit tests for get_list
-  # Get the details of a list
+  # Get a list's details
   # @param list_id Id of the list
   # @param [Hash] opts the optional parameters
   # @return [GetExtendedList]
@@ -117,7 +117,7 @@ describe 'ListsApi' do
   end
 
   # unit tests for remove_contact_from_list
-  # Remove existing contacts from a list
+  # Delete a contact from a list
   # @param list_id Id of the list
   # @param contact_emails Emails adresses of the contact
   # @param [Hash] opts the optional parameters

data/spec/api/reseller_api_spec.rb

@@ -57,7 +57,7 @@ describe 'ResellerApi' do
   end
 
   # unit tests for create_child_domain
-  # Creates a domain for a child account
+  # Create 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. This will not be displayed to the parent account.
   # @param [Hash] opts the optional parameters
@@ -80,7 +80,7 @@ describe 'ResellerApi' do
   end
 
   # unit tests for delete_child_domain
-  # Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed
+  # Delete the sender domain of the reseller child based on the childAuthKey and domainName passed
   # @param child_auth_key auth key of reseller's child
   # @param domain_name Pass the existing domain that needs to be deleted
   # @param [Hash] opts the optional parameters
@@ -92,7 +92,7 @@ describe 'ResellerApi' do
   end
 
   # unit tests for delete_reseller_child
-  # Deletes a single reseller child based on the childAuthKey supplied
+  # Delete a single reseller child based on the childAuthKey supplied
   # @param child_auth_key auth key of reseller's child
   # @param [Hash] opts the optional parameters
   # @return [nil]
@@ -115,7 +115,7 @@ describe 'ResellerApi' do
   end
 
   # unit tests for get_child_account_creation_status
-  # Returns the status of reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
+  # Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
   # @param child_auth_key auth key of reseller's child
   # @param [Hash] opts the optional parameters
   # @return [GetChildAccountCreationStatus]
@@ -126,7 +126,7 @@ describe 'ResellerApi' do
   end
 
   # unit tests for get_child_domains
-  # Gets all the sender domains of a specific child account
+  # Get all sender domains for a specific child account
   # @param child_auth_key auth key of reseller's child
   # @param [Hash] opts the optional parameters
   # @return [GetChildDomains]
@@ -137,7 +137,7 @@ describe 'ResellerApi' do
   end
 
   # unit tests for get_child_info
-  # Gets the info about a specific child account
+  # Get a child account's details
   # @param child_auth_key auth key of reseller's child
   # @param [Hash] opts the optional parameters
   # @return [GetChildInfo]
@@ -148,7 +148,7 @@ describe 'ResellerApi' do
   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
@@ -184,7 +184,7 @@ describe 'ResellerApi' do
   end
 
   # unit tests for update_child_account_status
-  # Updates infos of reseller's child account status based on the childAuthKey supplied
+  # Update info of reseller's child account status based on the childAuthKey supplied
   # @param child_auth_key auth key of reseller's child
   # @param update_child_account_status values to update in child account status
   # @param [Hash] opts the optional parameters
@@ -196,7 +196,7 @@ describe 'ResellerApi' do
   end
 
   # unit tests for update_child_domain
-  # Updates the sender domain of reseller's child based on the childAuthKey and domainName passed
+  # Update the sender domain of reseller's child based on the childAuthKey and domainName passed
   # @param child_auth_key auth key 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
@@ -209,7 +209,7 @@ describe 'ResellerApi' do
   end
 
   # unit tests for update_reseller_child
-  # Updates infos of reseller's child based on the childAuthKey supplied
+  # Update info of reseller's child based on the childAuthKey supplied
   # @param child_auth_key auth key of reseller's child
   # @param reseller_child values to update in child profile
   # @param [Hash] opts the optional parameters