brevo 2.0.0 → 3.0.0

data/lib/brevo/models/get_corporate_user_permission_groups.rb

@@ -0,0 +1,196 @@
+=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
+  # Groups details
+  class GetCorporateUserPermissionGroups
+    # group identifier
+    attr_accessor :id
+
+    # Group name
+    attr_accessor :name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'name' => :'name'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'id' => :'String',
+        :'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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      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 &&
+          name == o.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
+      [id, 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/get_coupon_collection.rb

@@ -14,24 +14,33 @@ require 'date'
 
 module Brevo
   class GetCouponCollection
-    # The id of the collection
+    # The id of the collection.
     attr_accessor :id
 
-    # The name of the collection
+    # The name of the collection.
     attr_accessor :name
 
-    # The default coupon of the collection
+    # The default coupon of the collection.
     attr_accessor :default_coupon
 
-    # Datetime on which the collection was created
+    # Datetime on which the collection was created.
     attr_accessor :created_at
 
-    # Total coupons in the collection
+    # Total number of coupons in the collection.
     attr_accessor :total_coupons
 
-    # Not sent coupons in the collection
+    # Number of coupons that have not been sent yet.
     attr_accessor :remaining_coupons
 
+    # Expiration date for the coupon collection in RFC3339 format.
+    attr_accessor :expiration_date
+
+    # If present, an email notification is going to be sent the defined amount of days before the expiration date.
+    attr_accessor :remaining_days_alert
+
+    # If present, an email notification is going to be sent when the total number of available coupons falls below the defined threshold.
+    attr_accessor :remaining_coupons_alert
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -40,7 +49,10 @@ module Brevo
         :'default_coupon' => :'defaultCoupon',
         :'created_at' => :'createdAt',
         :'total_coupons' => :'totalCoupons',
-        :'remaining_coupons' => :'remainingCoupons'
+        :'remaining_coupons' => :'remainingCoupons',
+        :'expiration_date' => :'expirationDate',
+        :'remaining_days_alert' => :'remainingDaysAlert',
+        :'remaining_coupons_alert' => :'remainingCouponsAlert'
       }
     end
 
@@ -52,7 +64,10 @@ module Brevo
         :'default_coupon' => :'String',
         :'created_at' => :'DateTime',
         :'total_coupons' => :'Integer',
-        :'remaining_coupons' => :'Integer'
+        :'remaining_coupons' => :'Integer',
+        :'expiration_date' => :'DateTime',
+        :'remaining_days_alert' => :'Integer',
+        :'remaining_coupons_alert' => :'Integer'
       }
     end
 
@@ -87,6 +102,18 @@ module Brevo
       if attributes.has_key?(:'remainingCoupons')
         self.remaining_coupons = attributes[:'remainingCoupons']
       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?
@@ -142,7 +169,10 @@ module Brevo
           default_coupon == o.default_coupon &&
           created_at == o.created_at &&
           total_coupons == o.total_coupons &&
-          remaining_coupons == o.remaining_coupons
+          remaining_coupons == o.remaining_coupons &&
+          expiration_date == o.expiration_date &&
+          remaining_days_alert == o.remaining_days_alert &&
+          remaining_coupons_alert == o.remaining_coupons_alert
     end
 
     # @see the `==` method
@@ -154,7 +184,7 @@ module Brevo
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, name, default_coupon, created_at, total_coupons, remaining_coupons].hash
+      [id, name, default_coupon, created_at, total_coupons, remaining_coupons, expiration_date, remaining_days_alert, remaining_coupons_alert].hash
     end
 
     # Builds the object from hash

data/lib/brevo/models/get_extended_contact_details.rb

@@ -130,10 +130,6 @@ module Brevo
     # @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 @id.nil?
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
@@ -172,7 +168,6 @@ 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 @email.nil?
       return false if @id.nil?
       return false if @email_blacklisted.nil?
       return false if @sms_blacklisted.nil?

data/lib/brevo/models/get_orders.rb

@@ -0,0 +1,196 @@
+=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 GetOrders
+    attr_accessor :orders
+
+    # Number of orders
+    attr_accessor :count
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'orders' => :'orders',
+        :'count' => :'count'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'orders' => :'Array<Object>',
+        :'count' => :'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?(:'orders')
+        if (value = attributes[:'orders']).is_a?(Array)
+          self.orders = value
+        end
+      end
+
+      if attributes.has_key?(:'count')
+        self.count = attributes[:'count']
+      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 &&
+          orders == o.orders &&
+          count == o.count
+    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
+      [orders, count].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/get_webhook.rb

@@ -34,6 +34,14 @@ module Brevo
     # Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ)
     attr_accessor :modified_at
 
+    # 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
@@ -65,7 +73,10 @@ module Brevo
         :'events' => :'events',
         :'type' => :'type',
         :'created_at' => :'createdAt',
-        :'modified_at' => :'modifiedAt'
+        :'modified_at' => :'modifiedAt',
+        :'batched' => :'batched',
+        :'auth' => :'auth',
+        :'headers' => :'headers'
       }
     end
 
@@ -78,7 +89,10 @@ module Brevo
         :'events' => :'Array<String>',
         :'type' => :'String',
         :'created_at' => :'String',
-        :'modified_at' => :'String'
+        :'modified_at' => :'String',
+        :'batched' => :'BOOLEAN',
+        :'auth' => :'GetWebhookAuth',
+        :'headers' => :'Array<GetWebhookHeaders>'
       }
     end
 
@@ -119,6 +133,20 @@ module Brevo
       if attributes.has_key?(:'modifiedAt')
         self.modified_at = attributes[:'modifiedAt']
       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?
@@ -192,7 +220,10 @@ module Brevo
           events == o.events &&
           type == o.type &&
           created_at == o.created_at &&
-          modified_at == o.modified_at
+          modified_at == o.modified_at &&
+          batched == o.batched &&
+          auth == o.auth &&
+          headers == o.headers
     end
 
     # @see the `==` method
@@ -204,7 +235,7 @@ module Brevo
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [url, id, description, events, type, created_at, modified_at].hash
+      [url, id, description, events, type, created_at, modified_at, batched, auth, headers].hash
     end
 
     # Builds the object from hash