brevo 3.0.0 → 4.0.0

data/lib/brevo/models/body_11.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
@@ -14,45 +14,35 @@ require 'date'
 
 module Brevo
   class Body11
-    # visitor’s ID received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a>
-    attr_accessor :visitor_id
+    # Name of deal
+    attr_accessor :name
 
-    # message text
-    attr_accessor :text
+    # Attributes for deal update  To assign owner of a Deal you can send attributes.deal_owner and utilize the account email or ID.  If you wish to update the pipeline of a deal you need to provide the `pipeline` and the `deal_stage`.  Pipeline and deal_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}` 
+    attr_accessor :attributes
 
-    # agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required).
-    attr_accessor :agent_id
+    # Warning - Using PATCH on linkedContactIds replaces the list of linked contacts. Omitted IDs will be removed.
+    attr_accessor :linked_contacts_ids
 
-    # mark your messages to distinguish messages created by you from the others.
-    attr_accessor :received_from
-
-    # agent email. When sending messages from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address.
-    attr_accessor :agent_email
-
-    # agent name
-    attr_accessor :agent_name
+    # Warning - Using PATCH on linkedCompaniesIds replaces the list of linked contacts. Omitted IDs will be removed.
+    attr_accessor :linked_companies_ids
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'visitor_id' => :'visitorId',
-        :'text' => :'text',
-        :'agent_id' => :'agentId',
-        :'received_from' => :'receivedFrom',
-        :'agent_email' => :'agentEmail',
-        :'agent_name' => :'agentName'
+        :'name' => :'name',
+        :'attributes' => :'attributes',
+        :'linked_contacts_ids' => :'linkedContactsIds',
+        :'linked_companies_ids' => :'linkedCompaniesIds'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'visitor_id' => :'String',
-        :'text' => :'String',
-        :'agent_id' => :'String',
-        :'received_from' => :'String',
-        :'agent_email' => :'String',
-        :'agent_name' => :'String'
+        :'name' => :'String',
+        :'attributes' => :'Object',
+        :'linked_contacts_ids' => :'Array<Integer>',
+        :'linked_companies_ids' => :'Array<String>'
       }
     end
 
@@ -64,28 +54,24 @@ module Brevo
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.has_key?(:'visitorId')
-        self.visitor_id = attributes[:'visitorId']
-      end
-
-      if attributes.has_key?(:'text')
-        self.text = attributes[:'text']
-      end
-
-      if attributes.has_key?(:'agentId')
-        self.agent_id = attributes[:'agentId']
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
       end
 
-      if attributes.has_key?(:'receivedFrom')
-        self.received_from = attributes[:'receivedFrom']
+      if attributes.has_key?(:'attributes')
+        self.attributes = attributes[:'attributes']
       end
 
-      if attributes.has_key?(:'agentEmail')
-        self.agent_email = attributes[:'agentEmail']
+      if attributes.has_key?(:'linkedContactsIds')
+        if (value = attributes[:'linkedContactsIds']).is_a?(Array)
+          self.linked_contacts_ids = value
+        end
       end
 
-      if attributes.has_key?(:'agentName')
-        self.agent_name = attributes[:'agentName']
+      if attributes.has_key?(:'linkedCompaniesIds')
+        if (value = attributes[:'linkedCompaniesIds']).is_a?(Array)
+          self.linked_companies_ids = value
+        end
       end
     end
 
@@ -93,22 +79,12 @@ module Brevo
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @visitor_id.nil?
-        invalid_properties.push('invalid value for "visitor_id", visitor_id cannot be nil.')
-      end
-
-      if @text.nil?
-        invalid_properties.push('invalid value for "text", text cannot be nil.')
-      end
-
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if @visitor_id.nil?
-      return false if @text.nil?
       true
     end
 
@@ -117,12 +93,10 @@ module Brevo
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          visitor_id == o.visitor_id &&
-          text == o.text &&
-          agent_id == o.agent_id &&
-          received_from == o.received_from &&
-          agent_email == o.agent_email &&
-          agent_name == o.agent_name
+          name == o.name &&
+          attributes == o.attributes &&
+          linked_contacts_ids == o.linked_contacts_ids &&
+          linked_companies_ids == o.linked_companies_ids
     end
 
     # @see the `==` method
@@ -134,7 +108,7 @@ module Brevo
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [visitor_id, text, agent_id, received_from, agent_email, agent_name].hash
+      [name, attributes, linked_contacts_ids, linked_companies_ids].hash
     end
 
     # Builds the object from hash

data/lib/brevo/models/body_12.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
@@ -14,20 +14,35 @@ require 'date'
 
 module Brevo
   class Body12
-    # edited message text
-    attr_accessor :text
+    # Contact ids for contacts to be linked with deal
+    attr_accessor :link_contact_ids
+
+    # Contact ids for contacts to be unlinked from deal
+    attr_accessor :unlink_contact_ids
+
+    # Company ids to be linked with deal
+    attr_accessor :link_company_ids
+
+    # Company ids to be unlinked from deal
+    attr_accessor :unlink_company_ids
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'text' => :'text'
+        :'link_contact_ids' => :'linkContactIds',
+        :'unlink_contact_ids' => :'unlinkContactIds',
+        :'link_company_ids' => :'linkCompanyIds',
+        :'unlink_company_ids' => :'unlinkCompanyIds'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'text' => :'String'
+        :'link_contact_ids' => :'Array<Integer>',
+        :'unlink_contact_ids' => :'Array<Integer>',
+        :'link_company_ids' => :'Array<String>',
+        :'unlink_company_ids' => :'Array<String>'
       }
     end
 
@@ -39,8 +54,28 @@ module Brevo
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.has_key?(:'text')
-        self.text = attributes[:'text']
+      if attributes.has_key?(:'linkContactIds')
+        if (value = attributes[:'linkContactIds']).is_a?(Array)
+          self.link_contact_ids = value
+        end
+      end
+
+      if attributes.has_key?(:'unlinkContactIds')
+        if (value = attributes[:'unlinkContactIds']).is_a?(Array)
+          self.unlink_contact_ids = value
+        end
+      end
+
+      if attributes.has_key?(:'linkCompanyIds')
+        if (value = attributes[:'linkCompanyIds']).is_a?(Array)
+          self.link_company_ids = value
+        end
+      end
+
+      if attributes.has_key?(:'unlinkCompanyIds')
+        if (value = attributes[:'unlinkCompanyIds']).is_a?(Array)
+          self.unlink_company_ids = value
+        end
       end
     end
 
@@ -48,17 +83,12 @@ module Brevo
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @text.nil?
-        invalid_properties.push('invalid value for "text", text cannot be nil.')
-      end
-
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if @text.nil?
       true
     end
 
@@ -67,7 +97,10 @@ module Brevo
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          text == o.text
+          link_contact_ids == o.link_contact_ids &&
+          unlink_contact_ids == o.unlink_contact_ids &&
+          link_company_ids == o.link_company_ids &&
+          unlink_company_ids == o.unlink_company_ids
     end
 
     # @see the `==` method
@@ -79,7 +112,7 @@ module Brevo
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [text].hash
+      [link_contact_ids, unlink_contact_ids, link_company_ids, unlink_company_ids].hash
     end
 
     # Builds the object from hash

data/lib/brevo/models/body_13.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
@@ -14,35 +14,69 @@ require 'date'
 
 module Brevo
   class Body13
-    # visitor’s ID received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a>
-    attr_accessor :visitor_id
+    # Name of task
+    attr_accessor :name
 
-    # message text
-    attr_accessor :text
+    # Duration of task in milliseconds [1 minute = 60000 ms]
+    attr_accessor :duration
 
-    # agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Optional if `groupId` is set.
-    attr_accessor :agent_id
+    # Id for type of task e.g Call / Email / Meeting etc.
+    attr_accessor :task_type_id
 
-    # group ID. It can be found on group’s page. Optional if `agentId` is set.
-    attr_accessor :group_id
+    # Task due date and time
+    attr_accessor :date
+
+    # Notes added to a task
+    attr_accessor :notes
+
+    # Task marked as done
+    attr_accessor :done
+
+    # To assign a task to a user you can use either the account email or ID.
+    attr_accessor :assign_to_id
+
+    # Contact ids for contacts linked to this task
+    attr_accessor :contacts_ids
+
+    # Deal ids for deals a task is linked to
+    attr_accessor :deals_ids
+
+    # Companies ids for companies a task is linked to
+    attr_accessor :companies_ids
+
+    attr_accessor :reminder
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'visitor_id' => :'visitorId',
-        :'text' => :'text',
-        :'agent_id' => :'agentId',
-        :'group_id' => :'groupId'
+        :'name' => :'name',
+        :'duration' => :'duration',
+        :'task_type_id' => :'taskTypeId',
+        :'date' => :'date',
+        :'notes' => :'notes',
+        :'done' => :'done',
+        :'assign_to_id' => :'assignToId',
+        :'contacts_ids' => :'contactsIds',
+        :'deals_ids' => :'dealsIds',
+        :'companies_ids' => :'companiesIds',
+        :'reminder' => :'reminder'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'visitor_id' => :'String',
-        :'text' => :'String',
-        :'agent_id' => :'String',
-        :'group_id' => :'String'
+        :'name' => :'String',
+        :'duration' => :'Integer',
+        :'task_type_id' => :'String',
+        :'date' => :'DateTime',
+        :'notes' => :'String',
+        :'done' => :'BOOLEAN',
+        :'assign_to_id' => :'String',
+        :'contacts_ids' => :'Array<Integer>',
+        :'deals_ids' => :'Array<String>',
+        :'companies_ids' => :'Array<String>',
+        :'reminder' => :'TaskReminder'
       }
     end
 
@@ -54,20 +88,54 @@ module Brevo
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.has_key?(:'visitorId')
-        self.visitor_id = attributes[:'visitorId']
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'duration')
+        self.duration = attributes[:'duration']
+      end
+
+      if attributes.has_key?(:'taskTypeId')
+        self.task_type_id = attributes[:'taskTypeId']
+      end
+
+      if attributes.has_key?(:'date')
+        self.date = attributes[:'date']
+      end
+
+      if attributes.has_key?(:'notes')
+        self.notes = attributes[:'notes']
+      end
+
+      if attributes.has_key?(:'done')
+        self.done = attributes[:'done']
+      end
+
+      if attributes.has_key?(:'assignToId')
+        self.assign_to_id = attributes[:'assignToId']
+      end
+
+      if attributes.has_key?(:'contactsIds')
+        if (value = attributes[:'contactsIds']).is_a?(Array)
+          self.contacts_ids = value
+        end
       end
 
-      if attributes.has_key?(:'text')
-        self.text = attributes[:'text']
+      if attributes.has_key?(:'dealsIds')
+        if (value = attributes[:'dealsIds']).is_a?(Array)
+          self.deals_ids = value
+        end
       end
 
-      if attributes.has_key?(:'agentId')
-        self.agent_id = attributes[:'agentId']
+      if attributes.has_key?(:'companiesIds')
+        if (value = attributes[:'companiesIds']).is_a?(Array)
+          self.companies_ids = value
+        end
       end
 
-      if attributes.has_key?(:'groupId')
-        self.group_id = attributes[:'groupId']
+      if attributes.has_key?(:'reminder')
+        self.reminder = attributes[:'reminder']
       end
     end
 
@@ -75,12 +143,20 @@ module Brevo
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @visitor_id.nil?
-        invalid_properties.push('invalid value for "visitor_id", visitor_id cannot be nil.')
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
       end
 
-      if @text.nil?
-        invalid_properties.push('invalid value for "text", text cannot be nil.')
+      if !@duration.nil? && @duration < 0
+        invalid_properties.push('invalid value for "duration", must be greater than or equal to 0.')
+      end
+
+      if @task_type_id.nil?
+        invalid_properties.push('invalid value for "task_type_id", task_type_id cannot be nil.')
+      end
+
+      if @date.nil?
+        invalid_properties.push('invalid value for "date", date cannot be nil.')
       end
 
       invalid_properties
@@ -89,20 +165,39 @@ module Brevo
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if @visitor_id.nil?
-      return false if @text.nil?
+      return false if @name.nil?
+      return false if !@duration.nil? && @duration < 0
+      return false if @task_type_id.nil?
+      return false if @date.nil?
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] duration Value to be assigned
+    def duration=(duration)
+      if !duration.nil? && duration < 0
+        fail ArgumentError, 'invalid value for "duration", must be greater than or equal to 0.'
+      end
+
+      @duration = duration
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          visitor_id == o.visitor_id &&
-          text == o.text &&
-          agent_id == o.agent_id &&
-          group_id == o.group_id
+          name == o.name &&
+          duration == o.duration &&
+          task_type_id == o.task_type_id &&
+          date == o.date &&
+          notes == o.notes &&
+          done == o.done &&
+          assign_to_id == o.assign_to_id &&
+          contacts_ids == o.contacts_ids &&
+          deals_ids == o.deals_ids &&
+          companies_ids == o.companies_ids &&
+          reminder == o.reminder
     end
 
     # @see the `==` method
@@ -114,7 +209,7 @@ module Brevo
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [visitor_id, text, agent_id, group_id].hash
+      [name, duration, task_type_id, date, notes, done, assign_to_id, contacts_ids, deals_ids, companies_ids, reminder].hash
     end
 
     # Builds the object from hash