sib-api-v3-sdk 7.5.0 → 8.0.0

data/lib/sib-api-v3-sdk/models/{send_email.rb → contact.rb}

@@ -13,61 +13,57 @@ Swagger Codegen version: 2.4.19
 require 'date'
 
 module SibApiV3Sdk
-  class SendEmail
-    # List of the email addresses of the recipients. For example, ['abc@example.com', 'asd@example.com'].
-    attr_accessor :email_to
+  # Contact Details
+  class Contact
+    # Next incomplete task of contact
+    attr_accessor :virtual_next_task
 
-    # List of the email addresses of the recipients in bcc
-    attr_accessor :email_bcc
+    # Contact email
+    attr_accessor :email
 
-    # List of the email addresses of the recipients in cc
-    attr_accessor :email_cc
+    # User id to whom contact is assigned
+    attr_accessor :assign_to_id
 
-    # Email address which shall be used by campaign recipients to reply back
-    attr_accessor :reply_to
+    # Contact id
+    attr_accessor :contacts_id
 
-    # Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps
-    attr_accessor :attachment_url
+    # CRM lists in which contact is added
+    attr_accessor :crm_lists
 
-    # Pass the list of content (base64 encoded) and name of the attachment. For example, [{\"content\":\"base64 encoded content 1\", \"name\":\"attcahment1\"}, {\"content\":\"base64 encoded content 2\", \"name\":\"attcahment2\"}].
-    attr_accessor :attachment
-
-    # Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, {\"Content-Type\":\"text/html\", \"charset\":\"iso-8859-1\", \"sender.ip\":\"1.2.3.4\"}
-    attr_accessor :headers
-
-    # Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}
+    # Contact attributes e.g firstname / lastname / SMS etc.
     attr_accessor :attributes
 
-    # Tag your emails to find them more easily
-    attr_accessor :tags
+    # Contact created date/time
+    attr_accessor :created_at
+
+    # Contact updated date/time
+    attr_accessor :updated_at
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'email_to' => :'emailTo',
-        :'email_bcc' => :'emailBcc',
-        :'email_cc' => :'emailCc',
-        :'reply_to' => :'replyTo',
-        :'attachment_url' => :'attachmentUrl',
-        :'attachment' => :'attachment',
-        :'headers' => :'headers',
+        :'virtual_next_task' => :'virtualNextTask',
+        :'email' => :'email',
+        :'assign_to_id' => :'assignToId',
+        :'contacts_id' => :'contactsId',
+        :'crm_lists' => :'crmLists',
         :'attributes' => :'attributes',
-        :'tags' => :'tags'
+        :'created_at' => :'createdAt',
+        :'updated_at' => :'updatedAt'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'email_to' => :'Array<String>',
-        :'email_bcc' => :'Array<String>',
-        :'email_cc' => :'Array<String>',
-        :'reply_to' => :'String',
-        :'attachment_url' => :'String',
-        :'attachment' => :'Array<SendEmailAttachment>',
-        :'headers' => :'Object',
+        :'virtual_next_task' => :'Object',
+        :'email' => :'String',
+        :'assign_to_id' => :'String',
+        :'contacts_id' => :'Integer',
+        :'crm_lists' => :'Object',
         :'attributes' => :'Object',
-        :'tags' => :'Array<String>'
+        :'created_at' => :'DateTime',
+        :'updated_at' => :'DateTime'
       }
     end
 
@@ -79,50 +75,36 @@ module SibApiV3Sdk
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.has_key?(:'emailTo')
-        if (value = attributes[:'emailTo']).is_a?(Array)
-          self.email_to = value
-        end
-      end
-
-      if attributes.has_key?(:'emailBcc')
-        if (value = attributes[:'emailBcc']).is_a?(Array)
-          self.email_bcc = value
-        end
-      end
-
-      if attributes.has_key?(:'emailCc')
-        if (value = attributes[:'emailCc']).is_a?(Array)
-          self.email_cc = value
-        end
+      if attributes.has_key?(:'virtualNextTask')
+        self.virtual_next_task = attributes[:'virtualNextTask']
       end
 
-      if attributes.has_key?(:'replyTo')
-        self.reply_to = attributes[:'replyTo']
+      if attributes.has_key?(:'email')
+        self.email = attributes[:'email']
       end
 
-      if attributes.has_key?(:'attachmentUrl')
-        self.attachment_url = attributes[:'attachmentUrl']
+      if attributes.has_key?(:'assignToId')
+        self.assign_to_id = attributes[:'assignToId']
       end
 
-      if attributes.has_key?(:'attachment')
-        if (value = attributes[:'attachment']).is_a?(Array)
-          self.attachment = value
-        end
+      if attributes.has_key?(:'contactsId')
+        self.contacts_id = attributes[:'contactsId']
       end
 
-      if attributes.has_key?(:'headers')
-        self.headers = attributes[:'headers']
+      if attributes.has_key?(:'crmLists')
+        self.crm_lists = attributes[:'crmLists']
       end
 
       if attributes.has_key?(:'attributes')
         self.attributes = attributes[:'attributes']
       end
 
-      if attributes.has_key?(:'tags')
-        if (value = attributes[:'tags']).is_a?(Array)
-          self.tags = value
-        end
+      if attributes.has_key?(:'createdAt')
+        self.created_at = attributes[:'createdAt']
+      end
+
+      if attributes.has_key?(:'updatedAt')
+        self.updated_at = attributes[:'updatedAt']
       end
     end
 
@@ -130,8 +112,12 @@ module SibApiV3Sdk
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @email_to.nil?
-        invalid_properties.push('invalid value for "email_to", email_to cannot be nil.')
+      if @email.nil?
+        invalid_properties.push('invalid value for "email", email cannot be nil.')
+      end
+
+      if @crm_lists.nil?
+        invalid_properties.push('invalid value for "crm_lists", crm_lists cannot be nil.')
       end
 
       invalid_properties
@@ -140,7 +126,8 @@ module SibApiV3Sdk
     # 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_to.nil?
+      return false if @email.nil?
+      return false if @crm_lists.nil?
       true
     end
 
@@ -149,15 +136,14 @@ module SibApiV3Sdk
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          email_to == o.email_to &&
-          email_bcc == o.email_bcc &&
-          email_cc == o.email_cc &&
-          reply_to == o.reply_to &&
-          attachment_url == o.attachment_url &&
-          attachment == o.attachment &&
-          headers == o.headers &&
+          virtual_next_task == o.virtual_next_task &&
+          email == o.email &&
+          assign_to_id == o.assign_to_id &&
+          contacts_id == o.contacts_id &&
+          crm_lists == o.crm_lists &&
           attributes == o.attributes &&
-          tags == o.tags
+          created_at == o.created_at &&
+          updated_at == o.updated_at
     end
 
     # @see the `==` method
@@ -169,7 +155,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [email_to, email_bcc, email_cc, reply_to, attachment_url, attachment, headers, attributes, tags].hash
+      [virtual_next_task, email, assign_to_id, contacts_id, crm_lists, attributes, created_at, updated_at].hash
     end
 
     # Builds the object from hash

data/lib/sib-api-v3-sdk/models/create_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?
@@ -135,7 +146,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
@@ -147,7 +159,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/create_sub_account.rb

@@ -0,0 +1,244 @@
+=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 CreateSubAccount
+    # Name of the organization
+    attr_accessor :company_name
+
+    # Language for identifying localization information
+    attr_accessor :language
+
+    # Request timezone of the client
+    attr_accessor :timezone
+
+    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
+      {
+        :'company_name' => :'companyName',
+        :'language' => :'language',
+        :'timezone' => :'timezone'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'company_name' => :'String',
+        :'language' => :'String',
+        :'timezone' => :'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?(:'companyName')
+        self.company_name = attributes[:'companyName']
+      end
+
+      if attributes.has_key?(:'language')
+        self.language = attributes[:'language']
+      end
+
+      if attributes.has_key?(:'timezone')
+        self.timezone = attributes[:'timezone']
+      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 @company_name.nil?
+        invalid_properties.push('invalid value for "company_name", company_name 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 @company_name.nil?
+      language_validator = EnumAttributeValidator.new('String', ['en', 'fr', 'it', 'es', 'pt', 'de'])
+      return false unless language_validator.valid?(@language)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] language Object to be assigned
+    def language=(language)
+      validator = EnumAttributeValidator.new('String', ['en', 'fr', 'it', 'es', 'pt', 'de'])
+      unless validator.valid?(language)
+        fail ArgumentError, 'invalid value for "language", must be one of #{validator.allowable_values}.'
+      end
+      @language = language
+    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 &&
+          company_name == o.company_name &&
+          language == o.language &&
+          timezone == o.timezone
+    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
+      [company_name, language, timezone].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/create_webhook.rb

@@ -20,12 +20,15 @@ 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` & `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
 
     # Type of the webhook
     attr_accessor :type
 
+    # Inbound domain of webhook, required in case of event type `inbound`
+    attr_accessor :domain
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -54,7 +57,8 @@ module SibApiV3Sdk
         :'url' => :'url',
         :'description' => :'description',
         :'events' => :'events',
-        :'type' => :'type'
+        :'type' => :'type',
+        :'domain' => :'domain'
       }
     end
 
@@ -64,7 +68,8 @@ module SibApiV3Sdk
         :'url' => :'String',
         :'description' => :'String',
         :'events' => :'Array<String>',
-        :'type' => :'String'
+        :'type' => :'String',
+        :'domain' => :'String'
       }
     end
 
@@ -95,6 +100,10 @@ module SibApiV3Sdk
       else
         self.type = 'transactional'
       end
+
+      if attributes.has_key?(:'domain')
+        self.domain = attributes[:'domain']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -117,7 +126,7 @@ module SibApiV3Sdk
     def valid?
       return false if @url.nil?
       return false if @events.nil?
-      type_validator = EnumAttributeValidator.new('String', ['transactional', 'marketing'])
+      type_validator = EnumAttributeValidator.new('String', ['transactional', 'marketing', 'inbound'])
       return false unless type_validator.valid?(@type)
       true
     end
@@ -125,7 +134,7 @@ module SibApiV3Sdk
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ['transactional', 'marketing'])
+      validator = EnumAttributeValidator.new('String', ['transactional', 'marketing', 'inbound'])
       unless validator.valid?(type)
         fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.'
       end
@@ -140,7 +149,8 @@ module SibApiV3Sdk
           url == o.url &&
           description == o.description &&
           events == o.events &&
-          type == o.type
+          type == o.type &&
+          domain == o.domain
     end
 
     # @see the `==` method
@@ -152,7 +162,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [url, description, events, type].hash
+      [url, description, events, type, domain].hash
     end
 
     # Builds the object from hash