brevo 2.0.0 → 4.0.0

data/lib/brevo/models/balance_limit.rb

@@ -0,0 +1,285 @@
+=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 'date'
+
+module Brevo
+  class BalanceLimit
+    # balance definition ID
+    attr_accessor :balance_definition_id
+
+    # Defines the type of constraint (e.g., transaction-based or amount-based).
+    attr_accessor :constraint_type
+
+    # Timestamp of when the balance limit was created.
+    attr_accessor :created_at
+
+    # Time unit for the balance limit (day, week, month, year).
+    attr_accessor :duration_unit
+
+    # Number of time units the balance limit applies to.
+    attr_accessor :duration_value
+
+    # Unique identifier for the balance limit.
+    attr_accessor :id
+
+    # Indicates if the limit resets periodically based on a sliding schedule.
+    attr_accessor :sliding_schedule
+
+    # Specifies whether the limit applies to credit or debit transactions.
+    attr_accessor :transaction_type
+
+    # Timestamp of the last update to the balance limit.
+    attr_accessor :updated_at
+
+    # The maximum allowed value for the defined constraint.
+    attr_accessor :value
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'balance_definition_id' => :'balanceDefinitionId',
+        :'constraint_type' => :'constraintType',
+        :'created_at' => :'createdAt',
+        :'duration_unit' => :'durationUnit',
+        :'duration_value' => :'durationValue',
+        :'id' => :'id',
+        :'sliding_schedule' => :'slidingSchedule',
+        :'transaction_type' => :'transactionType',
+        :'updated_at' => :'updatedAt',
+        :'value' => :'value'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'balance_definition_id' => :'String',
+        :'constraint_type' => :'String',
+        :'created_at' => :'String',
+        :'duration_unit' => :'String',
+        :'duration_value' => :'Integer',
+        :'id' => :'String',
+        :'sliding_schedule' => :'BOOLEAN',
+        :'transaction_type' => :'String',
+        :'updated_at' => :'String',
+        :'value' => :'Integer'
+      }
+    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?(:'balanceDefinitionId')
+        self.balance_definition_id = attributes[:'balanceDefinitionId']
+      end
+
+      if attributes.has_key?(:'constraintType')
+        self.constraint_type = attributes[:'constraintType']
+      end
+
+      if attributes.has_key?(:'createdAt')
+        self.created_at = attributes[:'createdAt']
+      end
+
+      if attributes.has_key?(:'durationUnit')
+        self.duration_unit = attributes[:'durationUnit']
+      end
+
+      if attributes.has_key?(:'durationValue')
+        self.duration_value = attributes[:'durationValue']
+      end
+
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'slidingSchedule')
+        self.sliding_schedule = attributes[:'slidingSchedule']
+      end
+
+      if attributes.has_key?(:'transactionType')
+        self.transaction_type = attributes[:'transactionType']
+      end
+
+      if attributes.has_key?(:'updatedAt')
+        self.updated_at = attributes[:'updatedAt']
+      end
+
+      if attributes.has_key?(:'value')
+        self.value = attributes[:'value']
+      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
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at 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 @created_at.nil?
+      return false if @updated_at.nil?
+      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 &&
+          balance_definition_id == o.balance_definition_id &&
+          constraint_type == o.constraint_type &&
+          created_at == o.created_at &&
+          duration_unit == o.duration_unit &&
+          duration_value == o.duration_value &&
+          id == o.id &&
+          sliding_schedule == o.sliding_schedule &&
+          transaction_type == o.transaction_type &&
+          updated_at == o.updated_at &&
+          value == o.value
+    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
+      [balance_definition_id, constraint_type, created_at, duration_unit, duration_value, id, sliding_schedule, transaction_type, updated_at, value].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/balance_order.rb

@@ -0,0 +1,345 @@
+=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 'date'
+
+module Brevo
+  # Represents an order linked to a balance definition, including amount, due date, and transaction details.
+  class BalanceOrder
+    # Order amount (must not be zero).
+    attr_accessor :amount
+
+    # Optional unique identifier (UUID) of the associated balance definition.
+    attr_accessor :balance_definition_id
+
+    # Unique identifier of the contact placing the order (must be ≥ 1).
+    attr_accessor :contact_id
+
+    # RFC3339 timestamp indicating when the order was created.
+    attr_accessor :created_at
+
+    # RFC3339 timestamp specifying when the order is due in the future.
+    attr_accessor :due_at
+
+    # Optional RFC3339 timestamp defining order expiration in the future.
+    attr_accessor :expires_at
+
+    # Unique identifier for the balance order.
+    attr_accessor :id
+
+    # Unique identifier of the loyalty program associated with the order.
+    attr_accessor :loyalty_program_id
+
+    # Optional metadata associated with the order.
+    attr_accessor :meta
+
+    # Optional RFC3339 timestamp indicating when the order was processed.
+    attr_accessor :processed_at
+
+    # Optional reference to the associated transaction ID.
+    attr_accessor :transactionid
+
+    # RFC3339 timestamp indicating the last update to the order.
+    attr_accessor :updated_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'amount' => :'amount',
+        :'balance_definition_id' => :'balanceDefinitionId',
+        :'contact_id' => :'contactId',
+        :'created_at' => :'createdAt',
+        :'due_at' => :'dueAt',
+        :'expires_at' => :'expiresAt',
+        :'id' => :'id',
+        :'loyalty_program_id' => :'loyaltyProgramId',
+        :'meta' => :'meta',
+        :'processed_at' => :'processedAt',
+        :'transactionid' => :'transactionid',
+        :'updated_at' => :'updatedAt'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'amount' => :'Float',
+        :'balance_definition_id' => :'String',
+        :'contact_id' => :'Integer',
+        :'created_at' => :'String',
+        :'due_at' => :'String',
+        :'expires_at' => :'String',
+        :'id' => :'String',
+        :'loyalty_program_id' => :'String',
+        :'meta' => :'Object',
+        :'processed_at' => :'String',
+        :'transactionid' => :'String',
+        :'updated_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?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.has_key?(:'balanceDefinitionId')
+        self.balance_definition_id = attributes[:'balanceDefinitionId']
+      end
+
+      if attributes.has_key?(:'contactId')
+        self.contact_id = attributes[:'contactId']
+      end
+
+      if attributes.has_key?(:'createdAt')
+        self.created_at = attributes[:'createdAt']
+      end
+
+      if attributes.has_key?(:'dueAt')
+        self.due_at = attributes[:'dueAt']
+      end
+
+      if attributes.has_key?(:'expiresAt')
+        self.expires_at = attributes[:'expiresAt']
+      end
+
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'loyaltyProgramId')
+        self.loyalty_program_id = attributes[:'loyaltyProgramId']
+      end
+
+      if attributes.has_key?(:'meta')
+        self.meta = attributes[:'meta']
+      end
+
+      if attributes.has_key?(:'processedAt')
+        self.processed_at = attributes[:'processedAt']
+      end
+
+      if attributes.has_key?(:'transactionid')
+        self.transactionid = attributes[:'transactionid']
+      end
+
+      if attributes.has_key?(:'updatedAt')
+        self.updated_at = attributes[:'updatedAt']
+      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
+      if @amount.nil?
+        invalid_properties.push('invalid value for "amount", amount cannot be nil.')
+      end
+
+      if @contact_id.nil?
+        invalid_properties.push('invalid value for "contact_id", contact_id cannot be nil.')
+      end
+
+      if @contact_id < 1
+        invalid_properties.push('invalid value for "contact_id", must be greater than or equal to 1.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @due_at.nil?
+        invalid_properties.push('invalid value for "due_at", due_at cannot be nil.')
+      end
+
+      if @loyalty_program_id.nil?
+        invalid_properties.push('invalid value for "loyalty_program_id", loyalty_program_id cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at 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 @amount.nil?
+      return false if @contact_id.nil?
+      return false if @contact_id < 1
+      return false if @created_at.nil?
+      return false if @due_at.nil?
+      return false if @loyalty_program_id.nil?
+      return false if @updated_at.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] contact_id Value to be assigned
+    def contact_id=(contact_id)
+      if contact_id.nil?
+        fail ArgumentError, 'contact_id cannot be nil'
+      end
+
+      if contact_id < 1
+        fail ArgumentError, 'invalid value for "contact_id", must be greater than or equal to 1.'
+      end
+
+      @contact_id = contact_id
+    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 &&
+          amount == o.amount &&
+          balance_definition_id == o.balance_definition_id &&
+          contact_id == o.contact_id &&
+          created_at == o.created_at &&
+          due_at == o.due_at &&
+          expires_at == o.expires_at &&
+          id == o.id &&
+          loyalty_program_id == o.loyalty_program_id &&
+          meta == o.meta &&
+          processed_at == o.processed_at &&
+          transactionid == o.transactionid &&
+          updated_at == o.updated_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
+      [amount, balance_definition_id, contact_id, created_at, due_at, expires_at, id, loyalty_program_id, meta, processed_at, transactionid, updated_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/block_domain.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