brevo 2.0.0 → 3.0.0

data/lib/brevo/models/inviteuser.rb

@@ -0,0 +1,221 @@
+=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 Inviteuser
+    # Email address for the organization
+    attr_accessor :email
+
+    # All access to the features
+    attr_accessor :all_features_access
+
+    attr_accessor :privileges
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'email' => :'email',
+        :'all_features_access' => :'all_features_access',
+        :'privileges' => :'privileges'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'email' => :'String',
+        :'all_features_access' => :'BOOLEAN',
+        :'privileges' => :'Array<InviteuserPrivileges>'
+      }
+    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?(:'all_features_access')
+        self.all_features_access = attributes[:'all_features_access']
+      end
+
+      if attributes.has_key?(:'privileges')
+        if (value = attributes[:'privileges']).is_a?(Array)
+          self.privileges = value
+        end
+      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 @email.nil?
+        invalid_properties.push('invalid value for "email", email cannot be nil.')
+      end
+
+      if @all_features_access.nil?
+        invalid_properties.push('invalid value for "all_features_access", all_features_access cannot be nil.')
+      end
+
+      if @privileges.nil?
+        invalid_properties.push('invalid value for "privileges", privileges 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 @email.nil?
+      return false if @all_features_access.nil?
+      return false if @privileges.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 &&
+          email == o.email &&
+          all_features_access == o.all_features_access &&
+          privileges == o.privileges
+    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, all_features_access, privileges].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/inviteuser_privileges.rb

@@ -0,0 +1,232 @@
+=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
+  # Privileges given to the user
+  class InviteuserPrivileges
+    # Feature name
+    attr_accessor :feature
+
+    # Permissions for a given feature
+    attr_accessor :permissions
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'feature' => :'feature',
+        :'permissions' => :'permissions'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'feature' => :'String',
+        :'permissions' => :'Array<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?(:'feature')
+        self.feature = attributes[:'feature']
+      end
+
+      if attributes.has_key?(:'permissions')
+        if (value = attributes[:'permissions']).is_a?(Array)
+          self.permissions = value
+        end
+      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?
+      feature_validator = EnumAttributeValidator.new('String', ['email_campaigns', 'sms_campaigns', 'contacts', 'templates', 'workflows', 'facebook_ads', 'landing_pages', 'transactional_emails', 'smtp_api', 'user_management', 'sales_platform', 'phone', 'conversations', 'senders_domains_dedicated_ips', 'push_notifications'])
+      return false unless feature_validator.valid?(@feature)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] feature Object to be assigned
+    def feature=(feature)
+      validator = EnumAttributeValidator.new('String', ['email_campaigns', 'sms_campaigns', 'contacts', 'templates', 'workflows', 'facebook_ads', 'landing_pages', 'transactional_emails', 'smtp_api', 'user_management', 'sales_platform', 'phone', 'conversations', 'senders_domains_dedicated_ips', 'push_notifications'])
+      unless validator.valid?(feature)
+        fail ArgumentError, 'invalid value for "feature", must be one of #{validator.allowable_values}.'
+      end
+      @feature = feature
+    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 &&
+          feature == o.feature &&
+          permissions == o.permissions
+    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
+      [feature, permissions].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/master_details_response_plan_info_features.rb

@@ -23,9 +23,15 @@ module Brevo
     # Quantity provided in the plan
     attr_accessor :quantity
 
+    # Quantity with overages provided in the plan (only applicable on ENTv2)
+    attr_accessor :quantity_with_overages
+
     # Quantity consumed by master
     attr_accessor :used
 
+    # Quantity consumed by sub-organizations over the admin plan limit (only applicable on ENTv2)
+    attr_accessor :used_overages
+
     # Quantity remaining in the plan
     attr_accessor :remaining
 
@@ -35,7 +41,9 @@ module Brevo
         :'name' => :'name',
         :'unit_value' => :'unitValue',
         :'quantity' => :'quantity',
+        :'quantity_with_overages' => :'quantityWithOverages',
         :'used' => :'used',
+        :'used_overages' => :'usedOverages',
         :'remaining' => :'remaining'
       }
     end
@@ -46,7 +54,9 @@ module Brevo
         :'name' => :'String',
         :'unit_value' => :'String',
         :'quantity' => :'Integer',
+        :'quantity_with_overages' => :'Integer',
         :'used' => :'Integer',
+        :'used_overages' => :'Integer',
         :'remaining' => :'Integer'
       }
     end
@@ -71,10 +81,18 @@ module Brevo
         self.quantity = attributes[:'quantity']
       end
 
+      if attributes.has_key?(:'quantityWithOverages')
+        self.quantity_with_overages = attributes[:'quantityWithOverages']
+      end
+
       if attributes.has_key?(:'used')
         self.used = attributes[:'used']
       end
 
+      if attributes.has_key?(:'usedOverages')
+        self.used_overages = attributes[:'usedOverages']
+      end
+
       if attributes.has_key?(:'remaining')
         self.remaining = attributes[:'remaining']
       end
@@ -101,7 +119,9 @@ module Brevo
           name == o.name &&
           unit_value == o.unit_value &&
           quantity == o.quantity &&
+          quantity_with_overages == o.quantity_with_overages &&
           used == o.used &&
+          used_overages == o.used_overages &&
           remaining == o.remaining
     end
 
@@ -114,7 +134,7 @@ module Brevo
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [name, unit_value, quantity, used, remaining].hash
+      [name, unit_value, quantity, quantity_with_overages, used, used_overages, remaining].hash
     end
 
     # Builds the object from hash

data/lib/brevo/models/order_batch.rb

@@ -20,11 +20,15 @@ module Brevo
     # Notify Url provided by client to get the status of batch request
     attr_accessor :notify_url
 
+    # Defines wether you want your orders to be considered as live data or as historical data (import of past data, synchronising data). True: orders will not trigger any automation workflows. False: orders will trigger workflows as usual.
+    attr_accessor :historical
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'orders' => :'orders',
-        :'notify_url' => :'notifyUrl'
+        :'notify_url' => :'notifyUrl',
+        :'historical' => :'historical'
       }
     end
 
@@ -32,7 +36,8 @@ module Brevo
     def self.swagger_types
       {
         :'orders' => :'Array<Order>',
-        :'notify_url' => :'String'
+        :'notify_url' => :'String',
+        :'historical' => :'BOOLEAN'
       }
     end
 
@@ -53,6 +58,12 @@ module Brevo
       if attributes.has_key?(:'notifyUrl')
         self.notify_url = attributes[:'notifyUrl']
       end
+
+      if attributes.has_key?(:'historical')
+        self.historical = attributes[:'historical']
+      else
+        self.historical = true
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -79,7 +90,8 @@ module Brevo
       return true if self.equal?(o)
       self.class == o.class &&
           orders == o.orders &&
-          notify_url == o.notify_url
+          notify_url == o.notify_url &&
+          historical == o.historical
     end
 
     # @see the `==` method
@@ -91,7 +103,7 @@ module Brevo
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [orders, notify_url].hash
+      [orders, notify_url, historical].hash
     end
 
     # Builds the object from hash