sib-api-v3-sdk 7.5.0 → 9.0.0

data/lib/sib-api-v3-sdk/models/update_batch_contacts_contacts.rb

@@ -0,0 +1,273 @@
+=begin
+#SendinBlue API
+
+#SendinBlue 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/sendinblue  **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@sendinblue.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.19
+
+=end
+
+require 'date'
+
+module SibApiV3Sdk
+  class UpdateBatchContactsContacts
+    # Email address of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms)
+    attr_accessor :email
+
+    # id of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms)
+    attr_accessor :id
+
+    # SMS of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms)
+    attr_accessor :sms
+
+    # Pass the set of attributes to be updated. **These attributes must be present in your account**. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, **{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}**. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in **SMS** field should be passed with proper country code. For example: **{\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"}** 
+    attr_accessor :attributes
+
+    # Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true)
+    attr_accessor :email_blacklisted
+
+    # Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true)
+    attr_accessor :sms_blacklisted
+
+    # Ids of the lists to add the contact to
+    attr_accessor :list_ids
+
+    # Ids of the lists to remove the contact from
+    attr_accessor :unlink_list_ids
+
+    # transactional email forbidden sender for contact. Use only for email Contact
+    attr_accessor :smtp_blacklist_sender
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'email' => :'email',
+        :'id' => :'id',
+        :'sms' => :'sms',
+        :'attributes' => :'attributes',
+        :'email_blacklisted' => :'emailBlacklisted',
+        :'sms_blacklisted' => :'smsBlacklisted',
+        :'list_ids' => :'listIds',
+        :'unlink_list_ids' => :'unlinkListIds',
+        :'smtp_blacklist_sender' => :'smtpBlacklistSender'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'email' => :'String',
+        :'id' => :'Integer',
+        :'sms' => :'String',
+        :'attributes' => :'Hash<String, Object>',
+        :'email_blacklisted' => :'BOOLEAN',
+        :'sms_blacklisted' => :'BOOLEAN',
+        :'list_ids' => :'Array<Integer>',
+        :'unlink_list_ids' => :'Array<Integer>',
+        :'smtp_blacklist_sender' => :'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?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'sms')
+        self.sms = attributes[:'sms']
+      end
+
+      if attributes.has_key?(:'attributes')
+        if (value = attributes[:'attributes']).is_a?(Hash)
+          self.attributes = value
+        end
+      end
+
+      if attributes.has_key?(:'emailBlacklisted')
+        self.email_blacklisted = attributes[:'emailBlacklisted']
+      end
+
+      if attributes.has_key?(:'smsBlacklisted')
+        self.sms_blacklisted = attributes[:'smsBlacklisted']
+      end
+
+      if attributes.has_key?(:'listIds')
+        if (value = attributes[:'listIds']).is_a?(Array)
+          self.list_ids = value
+        end
+      end
+
+      if attributes.has_key?(:'unlinkListIds')
+        if (value = attributes[:'unlinkListIds']).is_a?(Array)
+          self.unlink_list_ids = value
+        end
+      end
+
+      if attributes.has_key?(:'smtpBlacklistSender')
+        if (value = attributes[:'smtpBlacklistSender']).is_a?(Array)
+          self.smtp_blacklist_sender = 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?
+      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 &&
+          id == o.id &&
+          sms == o.sms &&
+          attributes == o.attributes &&
+          email_blacklisted == o.email_blacklisted &&
+          sms_blacklisted == o.sms_blacklisted &&
+          list_ids == o.list_ids &&
+          unlink_list_ids == o.unlink_list_ids &&
+          smtp_blacklist_sender == o.smtp_blacklist_sender
+    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, id, sms, attributes, email_blacklisted, sms_blacklisted, list_ids, unlink_list_ids, smtp_blacklist_sender].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 = SibApiV3Sdk.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/sib-api-v3-sdk/models/update_batch_contacts_model.rb

@@ -0,0 +1,197 @@
+=begin
+#SendinBlue API
+
+#SendinBlue 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/sendinblue  **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@sendinblue.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.19
+
+=end
+
+require 'date'
+
+module SibApiV3Sdk
+  class UpdateBatchContactsModel
+    attr_accessor :success_ids
+
+    attr_accessor :failure_ids
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'success_ids' => :'successIds',
+        :'failure_ids' => :'failureIds'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'success_ids' => :'Array<Integer>',
+        :'failure_ids' => :'Array<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?(:'successIds')
+        if (value = attributes[:'successIds']).is_a?(Array)
+          self.success_ids = value
+        end
+      end
+
+      if attributes.has_key?(:'failureIds')
+        if (value = attributes[:'failureIds']).is_a?(Array)
+          self.failure_ids = 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?
+      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 &&
+          success_ids == o.success_ids &&
+          failure_ids == o.failure_ids
+    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
+      [success_ids, failure_ids].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 = SibApiV3Sdk.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/sib-api-v3-sdk/models/update_contact.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module SibApiV3Sdk
   class UpdateContact
-    # Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"}
+    # Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attributes. For example, `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. The attribute's parameter should be passed in capital letter while updating a contact. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"}
     attr_accessor :attributes
 
     # Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true)

data/lib/sib-api-v3-sdk/models/update_email_campaign.rb

@@ -22,7 +22,7 @@ module SibApiV3Sdk
     # Name of the campaign
     attr_accessor :name
 
-    # Body of the message (HTML version). REQUIRED if htmlUrl is empty
+    # Body of the message (HTML version). If the campaign is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that campaign. REQUIRED if htmlUrl is empty
     attr_accessor :html_content
 
     # Url which contents the body of the email message. REQUIRED if htmlContent is empty

data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb

@@ -28,6 +28,9 @@ module SibApiV3Sdk
     # UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
     attr_accessor :scheduled_at
 
+    # Format of the message. It indicates whether the content should be treated as unicode or not.
+    attr_accessor :unicode_enabled
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -35,7 +38,8 @@ module SibApiV3Sdk
         :'sender' => :'sender',
         :'content' => :'content',
         :'recipients' => :'recipients',
-        :'scheduled_at' => :'scheduledAt'
+        :'scheduled_at' => :'scheduledAt',
+        :'unicode_enabled' => :'unicodeEnabled'
       }
     end
 
@@ -46,7 +50,8 @@ module SibApiV3Sdk
         :'sender' => :'String',
         :'content' => :'String',
         :'recipients' => :'CreateSmsCampaignRecipients',
-        :'scheduled_at' => :'String'
+        :'scheduled_at' => :'String',
+        :'unicode_enabled' => :'BOOLEAN'
       }
     end
 
@@ -77,6 +82,12 @@ module SibApiV3Sdk
       if attributes.has_key?(:'scheduledAt')
         self.scheduled_at = attributes[:'scheduledAt']
       end
+
+      if attributes.has_key?(:'unicodeEnabled')
+        self.unicode_enabled = attributes[:'unicodeEnabled']
+      else
+        self.unicode_enabled = false
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -116,7 +127,8 @@ module SibApiV3Sdk
           sender == o.sender &&
           content == o.content &&
           recipients == o.recipients &&
-          scheduled_at == o.scheduled_at
+          scheduled_at == o.scheduled_at &&
+          unicode_enabled == o.unicode_enabled
     end
 
     # @see the `==` method
@@ -128,7 +140,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [name, sender, content, recipients, scheduled_at].hash
+      [name, sender, content, recipients, scheduled_at, unicode_enabled].hash
     end
 
     # Builds the object from hash

data/lib/sib-api-v3-sdk/models/update_smtp_template.rb

@@ -22,7 +22,7 @@ module SibApiV3Sdk
     # Name of the template
     attr_accessor :template_name
 
-    # Required if htmlUrl is empty. Body of the message (HTML must have more than 10 characters)
+    # Required if htmlUrl is empty. If the template is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that template. Body of the message (HTML must have more than 10 characters)
     attr_accessor :html_content
 
     # Required if htmlContent is empty. URL to the body of the email (HTML)

data/lib/sib-api-v3-sdk/models/update_webhook.rb

@@ -20,9 +20,12 @@ module SibApiV3Sdk
     # Description of the webhook
     attr_accessor :description
 
-    # Events triggering the webhook. Possible values for Transactional type webhook – `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` and possible values for Marketing type webhook – `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` and `delivered`
+    # - Events triggering the webhook. Possible values for **Transactional** type webhook: #### `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` - Possible values for **Marketing** type webhook: #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` - Possible values for **Inbound** type webhook: #### `inboundEmailProcessed` 
     attr_accessor :events
 
+    # Inbound domain of webhook, used in case of event type `inbound`
+    attr_accessor :domain
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -50,7 +53,8 @@ module SibApiV3Sdk
       {
         :'url' => :'url',
         :'description' => :'description',
-        :'events' => :'events'
+        :'events' => :'events',
+        :'domain' => :'domain'
       }
     end
 
@@ -59,7 +63,8 @@ module SibApiV3Sdk
       {
         :'url' => :'String',
         :'description' => :'String',
-        :'events' => :'Array<String>'
+        :'events' => :'Array<String>',
+        :'domain' => :'String'
       }
     end
 
@@ -84,6 +89,10 @@ module SibApiV3Sdk
           self.events = value
         end
       end
+
+      if attributes.has_key?(:'domain')
+        self.domain = attributes[:'domain']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -106,7 +115,8 @@ module SibApiV3Sdk
       self.class == o.class &&
           url == o.url &&
           description == o.description &&
-          events == o.events
+          events == o.events &&
+          domain == o.domain
     end
 
     # @see the `==` method
@@ -118,7 +128,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [url, description, events].hash
+      [url, description, events, domain].hash
     end
 
     # Builds the object from hash