brevo 3.0.0 → 4.0.0

data/lib/brevo/models/main_billing_payload.rb

@@ -0,0 +1,245 @@
+=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 MainBillingPayload
+    # Address of the user
+    attr_accessor :address
+
+    # City of the user
+    attr_accessor :city
+
+    # Country code of the user
+    attr_accessor :country_code
+
+    # Payment method opted by the user
+    attr_accessor :payment_method
+
+    # Phone number of the user
+    attr_accessor :phone
+
+    # Postal Code of user's locations
+    attr_accessor :post_code
+
+    # Region where user resides
+    attr_accessor :region
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'address' => :'address',
+        :'city' => :'city',
+        :'country_code' => :'countryCode',
+        :'payment_method' => :'paymentMethod',
+        :'phone' => :'phone',
+        :'post_code' => :'postCode',
+        :'region' => :'region'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'address' => :'String',
+        :'city' => :'String',
+        :'country_code' => :'String',
+        :'payment_method' => :'String',
+        :'phone' => :'Integer',
+        :'post_code' => :'Integer',
+        :'region' => :'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?(:'address')
+        self.address = attributes[:'address']
+      end
+
+      if attributes.has_key?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.has_key?(:'countryCode')
+        self.country_code = attributes[:'countryCode']
+      end
+
+      if attributes.has_key?(:'paymentMethod')
+        self.payment_method = attributes[:'paymentMethod']
+      end
+
+      if attributes.has_key?(:'phone')
+        self.phone = attributes[:'phone']
+      end
+
+      if attributes.has_key?(:'postCode')
+        self.post_code = attributes[:'postCode']
+      end
+
+      if attributes.has_key?(:'region')
+        self.region = attributes[:'region']
+      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 &&
+          address == o.address &&
+          city == o.city &&
+          country_code == o.country_code &&
+          payment_method == o.payment_method &&
+          phone == o.phone &&
+          post_code == o.post_code &&
+          region == o.region
+    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
+      [address, city, country_code, payment_method, phone, post_code, region].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_children_list.rb → main_code_count_http_response.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
@@ -13,17 +13,13 @@ Swagger Codegen version: 2.4.19
 require 'date'
 
 module Brevo
-  class GetChildrenList
-    # Your children's account information
-    attr_accessor :children
-
-    # Number of child accounts
+  class MainCodeCountHttpResponse
+    # Number of codes
     attr_accessor :count
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'children' => :'children',
         :'count' => :'count'
       }
     end
@@ -31,7 +27,6 @@ module Brevo
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'children' => :'Array<Object>',
         :'count' => :'Integer'
       }
     end
@@ -44,12 +39,6 @@ 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?(:'children')
-        if (value = attributes[:'children']).is_a?(Array)
-          self.children = value
-        end
-      end
-
       if attributes.has_key?(:'count')
         self.count = attributes[:'count']
       end
@@ -73,7 +62,6 @@ module Brevo
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          children == o.children &&
           count == o.count
     end
 
@@ -86,7 +74,7 @@ module Brevo
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [children, count].hash
+      [count].hash
     end
 
     # Builds the object from hash

data/lib/brevo/models/main_create_redeem_payload.rb

@@ -0,0 +1,286 @@
+=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 MainCreateRedeemPayload
+    # Unique identifier for the attributed reward
+    attr_accessor :attributed_reward_id
+
+    # Redemption code for the reward
+    attr_accessor :code
+
+    # Unique identifier for the contact
+    attr_accessor :contact_id
+
+    # Identifier for the loyalty subscription
+    attr_accessor :loyalty_subscription_id
+
+    # Additional metadata associated with the redeem request
+    attr_accessor :meta
+
+    attr_accessor :order
+
+    # Unique identifier for the reward
+    attr_accessor :reward_id
+
+    # Time to live in seconds for the redemption request
+    attr_accessor :ttl
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'attributed_reward_id' => :'attributedRewardId',
+        :'code' => :'code',
+        :'contact_id' => :'contactId',
+        :'loyalty_subscription_id' => :'loyaltySubscriptionId',
+        :'meta' => :'meta',
+        :'order' => :'order',
+        :'reward_id' => :'rewardId',
+        :'ttl' => :'ttl'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'attributed_reward_id' => :'String',
+        :'code' => :'String',
+        :'contact_id' => :'Integer',
+        :'loyalty_subscription_id' => :'String',
+        :'meta' => :'Hash<String, Object>',
+        :'order' => :'MainCreateRedeemPayloadOrder',
+        :'reward_id' => :'String',
+        :'ttl' => :'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?(:'attributedRewardId')
+        self.attributed_reward_id = attributes[:'attributedRewardId']
+      end
+
+      if attributes.has_key?(:'code')
+        self.code = attributes[:'code']
+      end
+
+      if attributes.has_key?(:'contactId')
+        self.contact_id = attributes[:'contactId']
+      end
+
+      if attributes.has_key?(:'loyaltySubscriptionId')
+        self.loyalty_subscription_id = attributes[:'loyaltySubscriptionId']
+      end
+
+      if attributes.has_key?(:'meta')
+        if (value = attributes[:'meta']).is_a?(Hash)
+          self.meta = value
+        end
+      end
+
+      if attributes.has_key?(:'order')
+        self.order = attributes[:'order']
+      end
+
+      if attributes.has_key?(:'rewardId')
+        self.reward_id = attributes[:'rewardId']
+      end
+
+      if attributes.has_key?(:'ttl')
+        self.ttl = attributes[:'ttl']
+      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 !@contact_id.nil? && @contact_id < 1
+        invalid_properties.push('invalid value for "contact_id", must be greater than or equal to 1.')
+      end
+
+      if !@ttl.nil? && @ttl < 0
+        invalid_properties.push('invalid value for "ttl", must be greater than or equal to 0.')
+      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 !@contact_id.nil? && @contact_id < 1
+      return false if !@ttl.nil? && @ttl < 0
+      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? && contact_id < 1
+        fail ArgumentError, 'invalid value for "contact_id", must be greater than or equal to 1.'
+      end
+
+      @contact_id = contact_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ttl Value to be assigned
+    def ttl=(ttl)
+      if !ttl.nil? && ttl < 0
+        fail ArgumentError, 'invalid value for "ttl", must be greater than or equal to 0.'
+      end
+
+      @ttl = ttl
+    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 &&
+          attributed_reward_id == o.attributed_reward_id &&
+          code == o.code &&
+          contact_id == o.contact_id &&
+          loyalty_subscription_id == o.loyalty_subscription_id &&
+          meta == o.meta &&
+          order == o.order &&
+          reward_id == o.reward_id &&
+          ttl == o.ttl
+    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
+      [attributed_reward_id, code, contact_id, loyalty_subscription_id, meta, order, reward_id, ttl].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/{manage_ip.rb → main_create_redeem_payload_order.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
@@ -13,21 +13,17 @@ Swagger Codegen version: 2.4.19
 require 'date'
 
 module Brevo
-  class ManageIp
-    # Dedicated ID
-    attr_accessor :ip
-
+  # Order details for the redemption
+  class MainCreateRedeemPayloadOrder
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'ip' => :'ip'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'ip' => :'String'
       }
     end
 
@@ -38,10 +34,6 @@ 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?(:'ip')
-        self.ip = attributes[:'ip']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -61,8 +53,7 @@ module Brevo
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
-      self.class == o.class &&
-          ip == o.ip
+      self.class == o.class
     end
 
     # @see the `==` method
@@ -74,7 +65,7 @@ module Brevo
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [ip].hash
+      [].hash
     end
 
     # Builds the object from hash