brevo 2.0.0 → 3.0.0

data/lib/brevo/models/corporate_group_details_response_subaccounts.rb

@@ -0,0 +1,205 @@
+=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  | 
+
+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 'date'
+
+module Brevo
+  class CorporateGroupDetailsResponseSubaccounts
+    # Id of the sub-account organzation
+    attr_accessor :id
+
+    # Name of the sub-account organzation
+    attr_accessor :company_name
+
+    # Creation date of the sub-account organzation
+    attr_accessor :created_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'company_name' => :'companyName',
+        :'created_at' => :'createdAt'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'id' => :'Integer',
+        :'company_name' => :'String',
+        :'created_at' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'companyName')
+        self.company_name = attributes[:'companyName']
+      end
+
+      if attributes.has_key?(:'createdAt')
+        self.created_at = attributes[:'createdAt']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      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?
+      true
+    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 &&
+          id == o.id &&
+          company_name == o.company_name &&
+          created_at == o.created_at
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [id, company_name, created_at].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = Brevo.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/brevo/models/corporate_group_details_response_users.rb

@@ -0,0 +1,205 @@
+=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  | 
+
+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 'date'
+
+module Brevo
+  class CorporateGroupDetailsResponseUsers
+    # Email address of the user
+    attr_accessor :email
+
+    # Last name of the user
+    attr_accessor :last_name
+
+    # First name of the user
+    attr_accessor :first_name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'email' => :'email',
+        :'last_name' => :'lastName',
+        :'first_name' => :'firstName'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'email' => :'String',
+        :'last_name' => :'String',
+        :'first_name' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.has_key?(:'lastName')
+        self.last_name = attributes[:'lastName']
+      end
+
+      if attributes.has_key?(:'firstName')
+        self.first_name = attributes[:'firstName']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      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?
+      true
+    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 &&
+          email == o.email &&
+          last_name == o.last_name &&
+          first_name == o.first_name
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [email, last_name, first_name].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = Brevo.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/brevo/models/create_contact.rb

@@ -20,7 +20,7 @@ module Brevo
     # Pass your own Id to create a contact.
     attr_accessor :ext_id
 
-    # Pass the set of attributes and their values. The attribute's parameter should be passed in capital letter while creating a contact. These attributes must be present in your Brevo account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"}
+    # Pass the set of attributes and their values. The attribute's parameter should be passed in capital letter while creating a contact. Values that don't match the attribute type (e.g. text or string in a date attribute) will be ignored.These attributes must be present in your Brevo account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"}
     attr_accessor :attributes
 
     # Set this field to blacklist the contact for emails (emailBlacklisted = true)

data/lib/brevo/models/create_coupon_collection.rb

@@ -14,25 +14,40 @@ require 'date'
 
 module Brevo
   class CreateCouponCollection
-    # Name of the collection with no white spaces between words
+    # Name of the coupons collection
     attr_accessor :name
 
-    # A default coupon to be used in case there are no coupons left
+    # Default coupons collection name
     attr_accessor :default_coupon
 
+    # Specify an expiration date for the coupon collection in RFC3339 format. Use null to remove the expiration date.
+    attr_accessor :expiration_date
+
+    # Send a notification alert (email) when the remaining days until the expiration date are equal or fall bellow this number. Use null to disable alerts.
+    attr_accessor :remaining_days_alert
+
+    # Send a notification alert (email) when the remaining coupons count is equal or fall bellow this number. Use null to disable alerts.
+    attr_accessor :remaining_coupons_alert
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
-        :'default_coupon' => :'defaultCoupon'
+        :'default_coupon' => :'defaultCoupon',
+        :'expiration_date' => :'expirationDate',
+        :'remaining_days_alert' => :'remainingDaysAlert',
+        :'remaining_coupons_alert' => :'remainingCouponsAlert'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'name' => :'Object',
-        :'default_coupon' => :'Object'
+        :'name' => :'String',
+        :'default_coupon' => :'String',
+        :'expiration_date' => :'DateTime',
+        :'remaining_days_alert' => :'Integer',
+        :'remaining_coupons_alert' => :'Integer'
       }
     end
 
@@ -51,6 +66,18 @@ module Brevo
       if attributes.has_key?(:'defaultCoupon')
         self.default_coupon = attributes[:'defaultCoupon']
       end
+
+      if attributes.has_key?(:'expirationDate')
+        self.expiration_date = attributes[:'expirationDate']
+      end
+
+      if attributes.has_key?(:'remainingDaysAlert')
+        self.remaining_days_alert = attributes[:'remainingDaysAlert']
+      end
+
+      if attributes.has_key?(:'remainingCouponsAlert')
+        self.remaining_coupons_alert = attributes[:'remainingCouponsAlert']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -82,7 +109,10 @@ module Brevo
       return true if self.equal?(o)
       self.class == o.class &&
           name == o.name &&
-          default_coupon == o.default_coupon
+          default_coupon == o.default_coupon &&
+          expiration_date == o.expiration_date &&
+          remaining_days_alert == o.remaining_days_alert &&
+          remaining_coupons_alert == o.remaining_coupons_alert
     end
 
     # @see the `==` method
@@ -94,7 +124,7 @@ module Brevo
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [name, default_coupon].hash
+      [name, default_coupon, expiration_date, remaining_days_alert, remaining_coupons_alert].hash
     end
 
     # Builds the object from hash

data/lib/brevo/models/create_domain_model.rb

@@ -20,6 +20,9 @@ module Brevo
     # Domain
     attr_accessor :domain_name
 
+    # Domain Provider
+    attr_accessor :domain_provider
+
     # Success message
     attr_accessor :message
 
@@ -30,6 +33,7 @@ module Brevo
       {
         :'id' => :'id',
         :'domain_name' => :'domain_name',
+        :'domain_provider' => :'domain_provider',
         :'message' => :'message',
         :'dns_records' => :'dns_records'
       }
@@ -40,6 +44,7 @@ module Brevo
       {
         :'id' => :'Integer',
         :'domain_name' => :'String',
+        :'domain_provider' => :'String',
         :'message' => :'String',
         :'dns_records' => :'CreateDomainModelDnsRecords'
       }
@@ -61,6 +66,10 @@ module Brevo
         self.domain_name = attributes[:'domain_name']
       end
 
+      if attributes.has_key?(:'domain_provider')
+        self.domain_provider = attributes[:'domain_provider']
+      end
+
       if attributes.has_key?(:'message')
         self.message = attributes[:'message']
       end
@@ -95,6 +104,7 @@ module Brevo
       self.class == o.class &&
           id == o.id &&
           domain_name == o.domain_name &&
+          domain_provider == o.domain_provider &&
           message == o.message &&
           dns_records == o.dns_records
     end
@@ -108,7 +118,7 @@ module Brevo
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, domain_name, message, dns_records].hash
+      [id, domain_name, domain_provider, message, dns_records].hash
     end
 
     # Builds the object from hash

data/lib/brevo/models/create_domain_model_dns_records.rb

@@ -18,11 +18,14 @@ module Brevo
 
     attr_accessor :brevo_code
 
+    attr_accessor :dmarc_record
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'dkim_record' => :'dkim_record',
-        :'brevo_code' => :'brevo_code'
+        :'brevo_code' => :'brevo_code',
+        :'dmarc_record' => :'dmarc_record'
       }
     end
 
@@ -30,7 +33,8 @@ module Brevo
     def self.swagger_types
       {
         :'dkim_record' => :'CreateDomainModelDnsRecordsDkimRecord',
-        :'brevo_code' => :'CreateDomainModelDnsRecordsDkimRecord'
+        :'brevo_code' => :'CreateDomainModelDnsRecordsDkimRecord',
+        :'dmarc_record' => :'CreateDomainModelDnsRecordsDkimRecord'
       }
     end
 
@@ -49,6 +53,10 @@ module Brevo
       if attributes.has_key?(:'brevo_code')
         self.brevo_code = attributes[:'brevo_code']
       end
+
+      if attributes.has_key?(:'dmarc_record')
+        self.dmarc_record = attributes[:'dmarc_record']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -70,7 +78,8 @@ module Brevo
       return true if self.equal?(o)
       self.class == o.class &&
           dkim_record == o.dkim_record &&
-          brevo_code == o.brevo_code
+          brevo_code == o.brevo_code &&
+          dmarc_record == o.dmarc_record
     end
 
     # @see the `==` method
@@ -82,7 +91,7 @@ module Brevo
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [dkim_record, brevo_code].hash
+      [dkim_record, brevo_code, dmarc_record].hash
     end
 
     # Builds the object from hash

data/lib/brevo/models/create_webhook.rb

@@ -29,6 +29,14 @@ module Brevo
     # Inbound domain of webhook, required in case of event type `inbound`
     attr_accessor :domain
 
+    # To send batched webhooks
+    attr_accessor :batched
+
+    attr_accessor :auth
+
+    # Custom headers to be send with webhooks
+    attr_accessor :headers
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -58,7 +66,10 @@ module Brevo
         :'description' => :'description',
         :'events' => :'events',
         :'type' => :'type',
-        :'domain' => :'domain'
+        :'domain' => :'domain',
+        :'batched' => :'batched',
+        :'auth' => :'auth',
+        :'headers' => :'headers'
       }
     end
 
@@ -69,7 +80,10 @@ module Brevo
         :'description' => :'String',
         :'events' => :'Array<String>',
         :'type' => :'String',
-        :'domain' => :'String'
+        :'domain' => :'String',
+        :'batched' => :'BOOLEAN',
+        :'auth' => :'GetWebhookAuth',
+        :'headers' => :'Array<GetWebhookHeaders>'
       }
     end
 
@@ -104,6 +118,20 @@ module Brevo
       if attributes.has_key?(:'domain')
         self.domain = attributes[:'domain']
       end
+
+      if attributes.has_key?(:'batched')
+        self.batched = attributes[:'batched']
+      end
+
+      if attributes.has_key?(:'auth')
+        self.auth = attributes[:'auth']
+      end
+
+      if attributes.has_key?(:'headers')
+        if (value = attributes[:'headers']).is_a?(Array)
+          self.headers = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -150,7 +178,10 @@ module Brevo
           description == o.description &&
           events == o.events &&
           type == o.type &&
-          domain == o.domain
+          domain == o.domain &&
+          batched == o.batched &&
+          auth == o.auth &&
+          headers == o.headers
     end
 
     # @see the `==` method
@@ -162,7 +193,7 @@ module Brevo
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [url, description, events, type, domain].hash
+      [url, description, events, type, domain, batched, auth, headers].hash
     end
 
     # Builds the object from hash