brevo 2.0.0 → 4.0.0

data/spec/api/balance_api_spec.rb

@@ -0,0 +1,292 @@
+=begin
+#Brevo API
+
+#Brevo 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/brevo  **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  |   | 422  | Error. Unprocessable Entity | 
+
+OpenAPI spec version: 3.0.0
+Contact: contact@brevo.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.19
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Brevo::BalanceApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'BalanceApi' do
+  before do
+    # run before each test
+    @instance = Brevo::BalanceApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of BalanceApi' do
+    it 'should create an instance of BalanceApi' do
+      expect(@instance).to be_instance_of(Brevo::BalanceApi)
+    end
+  end
+
+  # unit tests for begin_transaction
+  # Create new transaction
+  # Creates new transaction and returns information
+  # @param pid Loyalty Program Id
+  # @param body Transaction Payload
+  # @param [Hash] opts the optional parameters
+  # @return [Transaction]
+  describe 'begin_transaction 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 cancel_transaction
+  # Cancel transaction
+  # Cancels transaction
+  # @param pid Loyalty Program Id
+  # @param tid Transaction Id
+  # @param [Hash] opts the optional parameters
+  # @return [Transaction]
+  describe 'cancel_transaction 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 complete_transaction
+  # Complete transaction
+  # Completes transaction
+  # @param pid Loyalty Program Id
+  # @param tid Transaction Id
+  # @param [Hash] opts the optional parameters
+  # @return [Transaction]
+  describe 'complete_transaction 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_balance_limit
+  # Create balance limits
+  # Creates balance limit and sends the created UUID along with the data
+  # @param pid Loyalty Program Id
+  # @param bdid Balance Definition Id
+  # @param body Balance Definition Payload
+  # @param [Hash] opts the optional parameters
+  # @return [BalanceLimit]
+  describe 'create_balance_limit 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_balance_order
+  # Create balance order
+  # Returns created order
+  # @param pid Loyalty Program Id
+  # @param body Order Payload
+  # @param [Hash] opts the optional parameters
+  # @return [BalanceOrder]
+  describe 'create_balance_order 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 delete_balance_definition
+  # Delete balance definition
+  # Delete Balance definition
+  # @param pid Loyalty Program Id
+  # @param bdid Balance Definition Id
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_balance_definition 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 delete_balance_limit
+  # Delete balance limit
+  # Delete balance limit
+  # @param pid Loyalty Program Id
+  # @param bdid Balance Definition Id
+  # @param blid Balance Limit Id
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_balance_limit 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_balance_definition
+  # Get balance definition
+  # Returns balance definition
+  # @param pid Loyalty Program Id
+  # @param bdid Balance Definition Id
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :version Version
+  # @return [BalanceDefinition]
+  describe 'get_balance_definition 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_balance_definition_list
+  # Get balance definition list
+  # Returns balance definition page
+  # @param pid Loyalty Program Id
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit Limit the number of records returned
+  # @option opts [Integer] :offset Offset to paginate records
+  # @option opts [String] :sort_field Field to sort by
+  # @option opts [String] :sort Sort direction
+  # @option opts [String] :version Version
+  # @return [BalanceDefinitionPage]
+  describe 'get_balance_definition_list 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_balance_limit
+  # Get balance limits
+  # Fetches balance limits and send the created UUID along with the data
+  # @param pid Loyalty Program Id
+  # @param bdid Balance Definition Id
+  # @param blid Balance Limit Id
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :version Version
+  # @return [BalanceLimit]
+  describe 'get_balance_limit 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_contact_balances
+  # Get balance list
+  # Returns balance list
+  # @param pid Loyalty Program Id
+  # @param [Hash] opts the optional parameters
+  # @return [ContactBalancesResp]
+  describe 'get_contact_balances 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_subscription_balances
+  # Get subscription balances
+  # Returns subscription balances
+  # @param cid Contact Id
+  # @param pid Loyalty Program Id
+  # @param [Hash] opts the optional parameters
+  # @return [ModelSubscriptionBalanceResp]
+  describe 'get_subscription_balances 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 loyalty_balance_programs_pid_active_balance_get
+  # Get Active Balances API
+  # Returns Active Balances
+  # @param pid Loyalty Program Id
+  # @param contact_id Contact ID
+  # @param balance_definition_id Balance Definition ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit Limit
+  # @option opts [Integer] :offset Offset
+  # @option opts [String] :sort_field Sort Field
+  # @option opts [String] :sort Sort Order
+  # @return [BalanceLimit]
+  describe 'loyalty_balance_programs_pid_active_balance_get 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 loyalty_balance_programs_pid_balance_definitions_post
+  # Create balance definition
+  # Creates balance definition and returns information
+  # @param pid Loyalty Program Id
+  # @param body Create Balance Definition Payload
+  # @param [Hash] opts the optional parameters
+  # @return [BalanceDefinition]
+  describe 'loyalty_balance_programs_pid_balance_definitions_post 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 loyalty_balance_programs_pid_subscriptions_cid_balances_post
+  # Create subscription balances
+  # Creates a balance for a contact
+  # @param pid Loyalty Program Id
+  # @param cid Contact Id
+  # @param body Create Balnce Payload
+  # @param [Hash] opts the optional parameters
+  # @return [Balance]
+  describe 'loyalty_balance_programs_pid_subscriptions_cid_balances_post 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 loyalty_balance_programs_pid_transaction_history_get
+  # Get Transaction History API
+  # Returns transaction history
+  # @param pid Loyalty Program Id
+  # @param contact_id Contact ID
+  # @param balance_definition_id Balance Definition ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit Limit the number of records returned
+  # @option opts [Integer] :offset Skip a number of records
+  # @option opts [String] :sort_field Field to sort by
+  # @option opts [String] :sort Sort order, either asc or desc
+  # @option opts [Array<String>] :filters Filters to apply
+  # @return [TransactionHistoryResp]
+  describe 'loyalty_balance_programs_pid_transaction_history_get 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_balance_definition
+  # Update balance definition
+  # Updates Balance definition
+  # @param pid Loyalty Program Id
+  # @param bdid Balance Definition Id
+  # @param body Update Balance Definition Payload
+  # @param [Hash] opts the optional parameters
+  # @return [BalanceDefinition]
+  describe 'update_balance_definition 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_balance_limit
+  # Updates balance limit
+  # Updates balance limit
+  # @param pid Loyalty Program Id
+  # @param bdid Balance Definition Id
+  # @param blid Balance Limit Id
+  # @param body Balance Limits Payload
+  # @param [Hash] opts the optional parameters
+  # @return [BalanceLimit]
+  describe 'update_balance_limit 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/companies_api_spec.rb

@@ -1,7 +1,7 @@
 =begin
 #Brevo API
 
-#Brevo 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/brevo  **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  | 
+#Brevo 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/brevo  **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  |   | 422  | Error. Unprocessable Entity | 
 
 OpenAPI spec version: 3.0.0
 Contact: contact@brevo.com
@@ -32,22 +32,14 @@ describe 'CompaniesApi' do
     end
   end
 
-  # unit tests for companies_attributes_get
-  # Get company attributes
-  # @param [Hash] opts the optional parameters
-  # @return [CompanyAttributes]
-  describe 'companies_attributes_get 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 companies_get
   # Get all companies
   # @param [Hash] opts the optional parameters
   # @option opts [String] :filters Filter by attrbutes. If you have filter for owner on your side please send it as {\"attributes.owner\":\"5b1a17d914b73d35a76ca0c7\"}
   # @option opts [Integer] :linked_contacts_ids Filter by linked contacts ids
   # @option opts [String] :linked_deals_ids Filter by linked deals ids
+  # @option opts [String] :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.
+  # @option opts [String] :created_since Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
   # @option opts [Integer] :page Index of the first document of the page
   # @option opts [Integer] :limit Number of documents per page
   # @option opts [String] :sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
@@ -93,6 +85,19 @@ describe 'CompaniesApi' do
     end
   end
 
+  # unit tests for companies_import_post
+  # Import companies(creation and updation)
+  # Import companies from a CSV file with mapping options.
+  # @param file The CSV file to upload.The file should have the first row as the mapping attribute. Some default attribute names are (a) company_id [brevo mongoID to update deals] (b) associated_contact (c) associated_deal (f) any other attribute with internal name 
+  # @param mapping The mapping options in JSON format.   json    {       \"link_entities\": true, // Determines whether to link related entities during the import process       \"unlink_entities\": false, //Determines whether to unlink related entities during the import process.       \"update_existing_records\": true, // Determines whether to update based on company ID or treat every row as create       \"unset_empty_attributes\": false // Determines whether unset a specific attribute during update if values input is blank       \"use_company_identifier\": false // Determines whether to use company name as identifier     } 
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2004]
+  describe 'companies_import_post 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 companies_link_unlink_id_patch
   # Link and Unlink company with contacts and deals
   # @param id 
@@ -109,11 +114,32 @@ describe 'CompaniesApi' do
   # Create a company
   # @param body Company create data.
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse200]
+  # @return [InlineResponse2002]
   describe 'companies_post 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 crm_attributes_companies_get
+  # Get company attributes
+  # @param [Hash] opts the optional parameters
+  # @return [CompanyAttributes]
+  describe 'crm_attributes_companies_get 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 crm_attributes_post
+  # Create a deal/company attribute
+  # @param body Attribute creation data for company
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2003]
+  describe 'crm_attributes_post 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/contacts_api_spec.rb

@@ -1,7 +1,7 @@
 =begin
 #Brevo API
 
-#Brevo 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/brevo  **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  | 
+#Brevo 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/brevo  **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  |   | 422  | Error. Unprocessable Entity | 
 
 OpenAPI spec version: 3.0.0
 Contact: contact@brevo.com
@@ -35,7 +35,7 @@ describe 'ContactsApi' do
   # unit tests for add_contact_to_list
   # Add existing contacts to a list
   # @param list_id Id of the list
-  # @param contact_emails Emails addresses OR IDs of the contacts
+  # @param contact_emails Emails addresses OR IDs OR EXT_ID attributes of the contacts
   # @param [Hash] opts the optional parameters
   # @return [PostContactInfo]
   describe 'add_contact_to_list test' do
@@ -59,6 +59,7 @@ describe 'ContactsApi' do
 
   # unit tests for create_contact
   # Create a contact
+  # Creates new contacts on Brevo. Contacts can be created by passing either - <br><br> 1. email address of the contact (email_id),  <br> 2. phone number of the contact (to be passed as \"SMS\" field in \"attributes\" along with proper country code), For example- {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} <br> 3. ext_id <br>
   # @param create_contact Values to create a contact
   # @param [Hash] opts the optional parameters
   # @return [CreateUpdateContactModel]
@@ -115,8 +116,10 @@ describe 'ContactsApi' do
 
   # unit tests for delete_contact
   # Delete a contact
-  # @param identifier Email (urlencoded) OR ID of the contact
+  # There are 2 ways to delete a contact <br><br> Option 1- https://api.brevo.com/v3/contacts/{identifier} <br><br> Option 2- https://api.brevo.com/v3/contacts/{identifier}?identifierType={} <br> <br> Option 1 only works if identifierType is email_id (for EMAIL) or contact_id (for ID of the contact),where you can directly pass the value of EMAIL and ID of the contact.   <br><br> Option 2 works for all identifierType, use email_id for EMAIL attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, phone_id for SMS attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute.
+  # @param identifier Email (urlencoded) OR ID of the contact OR EXT_ID attribute (urlencoded)
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :identifier_type email_id for Email, contact_id for ID of the contact, ext_id for EXT_ID attribute, phone_id for SMS attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute
   # @return [nil]
   describe 'delete_contact test' do
     it 'should work' do
@@ -146,6 +149,19 @@ describe 'ContactsApi' do
     end
   end
 
+  # unit tests for delete_multi_attribute_options
+  # Delete a multiple-choice attribute option
+  # @param attribute_type Type of the attribute
+  # @param multiple_choice_attribute Name of the existing multiple-choice attribute
+  # @param multiple_choice_attribute_option Name of the existing multiple-choice attribute option that you want to delete
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_multi_attribute_options 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_attributes
   # List all attributes
   # @param [Hash] opts the optional parameters
@@ -158,9 +174,10 @@ describe 'ContactsApi' do
 
   # unit tests for get_contact_info
   # Get a contact's details
-  # Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats (https://developers.brevo.com/reference/contacts-7#getcontactstats) endpoint with the appropriate date ranges.
-  # @param identifier Email (urlencoded) OR ID of the contact OR its SMS attribute value
+  # There are 2 ways to get a contact <br><br> Option 1- https://api.brevo.com/v3/contacts/{identifier} <br><br> Option 2- https://api.brevo.com/v3/contacts/{identifier}?identifierType={} <br> <br> Option 1 only works if identifierType is email_id (for EMAIL), phone_id (for SMS) or contact_id (for ID of the contact),where you can directly pass the value of EMAIL, SMS and ID of the contact.   <br><br> Option 2 works for all identifierType, use email_id for EMAIL attribute, phone_id for SMS attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute <br><br>Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats ``https://developers.brevo.com/reference/contacts-7#getcontactstats`` endpoint with the appropriate date ranges.
+  # @param identifier Email (urlencoded) OR ID of the contact OR its SMS attribute value OR EXT_ID attribute (urlencoded)
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :identifier_type email_id for Email, phone_id for SMS attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute
   # @option opts [String] :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 [String] :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 [GetExtendedContactDetails]
@@ -191,6 +208,9 @@ describe 'ContactsApi' do
   # @option opts [String] :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.
   # @option opts [String] :created_since Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
   # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
+  # @option opts [Integer] :segment_id Id of the segment. **Either listIds or segmentId can be passed.**
+  # @option opts [Array<Integer>] :list_ids Ids of the list. **Either listIds or segmentId can be passed.**
+  # @option opts [String] :filter Filter the contacts on the basis of attributes. **Allowed operator: equals. For multiple-choice options, the filter will apply an AND condition between the options. For category attributes, the filter will work with both id and value. (e.g. filter&#x3D;equals(FIRSTNAME,\&quot;Antoine\&quot;), filter&#x3D;equals(B1, true), filter&#x3D;equals(DOB, \&quot;1989-11-23\&quot;), filter&#x3D;equals(GENDER, \&quot;1\&quot;), filter&#x3D;equals(GENDER, \&quot;MALE\&quot;), filter&#x3D;equals(COUNTRY,\&quot;USA, INDIA\&quot;)** 
   # @return [GetContacts]
   describe 'get_contacts test' do
     it 'should work' do
@@ -240,9 +260,9 @@ describe 'ContactsApi' do
 
   # unit tests for get_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
+  # @option opts [Integer] :limit Number of documents per page
+  # @option opts [Integer] :offset Index of the first document of the page
   # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
   # @return [GetFolders]
   describe 'get_folders test' do
@@ -255,6 +275,8 @@ describe 'ContactsApi' do
   # Get a list&#39;s details
   # @param list_id Id of the list
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :start_date Mandatory if endDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id.Prefer to pass your timezone in date-time format for accurate result
+  # @option opts [String] :end_date Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id.Prefer to pass your timezone in date-time format for accurate result
   # @return [GetExtendedList]
   describe 'get_list test' do
     it 'should work' do
@@ -290,7 +312,7 @@ describe 'ContactsApi' do
 
   # unit tests for import_contacts
   # Import contacts
-  # It returns the background process ID which on completion calls the notify URL that you have set in the input.
+  # It returns the background process ID which on completion calls the notify URL that you have set in the input.  **Note**: - Any contact attribute that doesn&#39;t exist in your account will be ignored at import end. 
   # @param request_contact_import Values to import contacts in Brevo. To know more about the expected format, please have a look at &#x60;&#x60;https://help.brevo.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns&#x60;&#x60;
   # @param [Hash] opts the optional parameters
   # @return [CreatedProcessId]
@@ -303,7 +325,7 @@ describe 'ContactsApi' do
   # unit tests for remove_contact_from_list
   # Delete a contact from a list
   # @param list_id Id of the list
-  # @param contact_emails Emails addresses OR IDs of the contacts
+  # @param contact_emails Emails addresses OR IDs OR EXT_ID attributes of the contacts
   # @param [Hash] opts the optional parameters
   # @return [PostContactInfo]
   describe 'remove_contact_from_list test' do
@@ -350,9 +372,11 @@ describe 'ContactsApi' do
 
   # unit tests for update_contact
   # Update a contact
-  # @param identifier Email (urlencoded) OR ID of the contact
+  # There are 2 ways to update a contact &lt;br&gt;&lt;br&gt; Option 1- https://api.brevo.com/v3/contacts/{identifier} &lt;br&gt;&lt;br&gt; Option 2- https://api.brevo.com/v3/contacts/{identifier}?identifierType&#x3D;{} &lt;br&gt; &lt;br&gt; Option 1 only works if identifierType is email_id (for EMAIL) or contact_id (for ID of the contact),where you can directly pass the value of EMAIL and ID of the contact.   &lt;br&gt;&lt;br&gt; Option 2 works for all identifierType, use email_id for EMAIL attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, phone_id for SMS attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE attribute
+  # @param identifier Email (urlencoded) OR ID of the contact OR EXT_ID attribute (urlencoded) OR its SMS attribute value OR its WHATSAPP attribute value OR its LANDLINE attribute value
   # @param update_contact Values to update a contact
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :identifier_type email_id for Email, contact_id for ID of the contact, ext_id for EXT_ID attribute, phone_id for SMS attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE attribute
   # @return [nil]
   describe 'update_contact test' do
     it 'should work' do

data/spec/api/conversations_api_spec.rb

@@ -1,7 +1,7 @@
 =begin
 #Brevo API
 
-#Brevo 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/brevo  **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  | 
+#Brevo 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/brevo  **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  |   | 422  | Error. Unprocessable Entity | 
 
 OpenAPI spec version: 3.0.0
 Contact: contact@brevo.com
@@ -72,7 +72,7 @@ describe 'ConversationsApi' do
   # Only agents’ messages can be edited.
   # @param id ID of the message
   # @param [Hash] opts the optional parameters
-  # @option opts [Body9] :body 
+  # @option opts [Body16] :body 
   # @return [ConversationsMessage]
   describe 'conversations_messages_id_put test' do
     it 'should work' do

data/spec/api/coupons_api_spec.rb

@@ -1,7 +1,7 @@
 =begin
 #Brevo API
 
-#Brevo 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/brevo  **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  | 
+#Brevo 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/brevo  **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  |   | 422  | Error. Unprocessable Entity | 
 
 OpenAPI spec version: 3.0.0
 Contact: contact@brevo.com
@@ -36,7 +36,7 @@ describe 'CouponsApi' do
   # Create а coupon collection
   # @param create_coupon_collection Values to create a coupon collection
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2012]
+  # @return [InlineResponse2013]
   describe 'create_coupon_collection test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -71,6 +71,7 @@ describe 'CouponsApi' do
   # @option opts [Integer] :limit Number of documents returned per page
   # @option opts [Integer] :offset Index of the first document on the page
   # @option opts [String] :sort Sort the results by creation time in ascending/descending order
+  # @option opts [String] :sort_by The field used to sort coupon collections
   # @return [GetCouponCollection]
   describe 'get_coupon_collections test' do
     it 'should work' do
@@ -81,9 +82,9 @@ describe 'CouponsApi' do
   # unit tests for update_coupon_collection
   # Update a coupon collection by id
   # @param id Id of the collection to update
-  # @param update_coupon_collection Values to update the coupon collection
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2001]
+  # @option opts [UpdateCouponCollection] :update_coupon_collection Values to update the coupon collection
+  # @return [InlineResponse2009]
   describe 'update_coupon_collection test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/api/deals_api_spec.rb

@@ -1,7 +1,7 @@
 =begin
 #Brevo API
 
-#Brevo 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/brevo  **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  | 
+#Brevo 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/brevo  **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  |   | 422  | Error. Unprocessable Entity | 
 
 OpenAPI spec version: 3.0.0
 Contact: contact@brevo.com
@@ -42,12 +42,25 @@ describe 'DealsApi' do
     end
   end
 
+  # unit tests for crm_attributes_post
+  # Create a deal/company attribute
+  # @param body Attribute creation data for company
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2003]
+  describe 'crm_attributes_post 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 crm_deals_get
   # Get all deals
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filters_attributes_deal_name Filter by attributes. If you have filter for owner on your side please send it as `filters[attributes.deal_owner]`.\"
+  # @option opts [String] :filters_attributes_deal_name Filter by attributes. If you have a filter for the owner on your end, please send it as filters[attributes.deal_owner] and utilize the account email for the filtering.
   # @option opts [String] :filters_linked_companies_ids Filter by linked companies ids
   # @option opts [String] :filters_linked_contacts_ids Filter by linked companies ids
+  # @option opts [String] :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.
+  # @option opts [String] :created_since Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
   # @option opts [Integer] :offset Index of the first document of the page
   # @option opts [Integer] :limit Number of documents per page
   # @option opts [String] :sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
@@ -93,6 +106,19 @@ describe 'DealsApi' do
     end
   end
 
+  # unit tests for crm_deals_import_post
+  # Import deals(creation and updation)
+  # Import deals from a CSV file with mapping options.
+  # @param file The CSV file to upload.The file should have the first row as the mapping attribute. Some default attribute names are (a) deal_id [brevo mongoID to update deals] (b) associated_contact (c) associated_company (f) any other attribute with internal name 
+  # @param mapping The mapping options in JSON format.   json    {       \"link_entities\": true, // Determines whether to link related entities during the import process       \"unlink_entities\": false, //Determines whether to unlink related entities during the import process.       \"update_existing_records\": true, // Determines whether to update based on deal ID or treat every row as create       \"unset_empty_attributes\": false // Determines whether unset a specific attribute during update if values input is blank     } 
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2004]
+  describe 'crm_deals_import_post 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 crm_deals_link_unlink_id_patch
   # Link and Unlink a deal with contacts and companies
   # @param id 
@@ -109,7 +135,7 @@ describe 'DealsApi' do
   # Create a deal
   # @param body Deal create data.
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse201]
+  # @return [InlineResponse2011]
   describe 'crm_deals_post test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/api/domains_api_spec.rb

@@ -1,7 +1,7 @@
 =begin
 #Brevo API
 
-#Brevo 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/brevo  **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  | 
+#Brevo 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/brevo  **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  |   | 422  | Error. Unprocessable Entity | 
 
 OpenAPI spec version: 3.0.0
 Contact: contact@brevo.com