sib-api-v3-sdk 8.1.0 → 9.1.0

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

@@ -14,16 +14,16 @@ require 'date'
 
 module SibApiV3Sdk
   class SubAccountsResponseSubAccounts
-    # client id of sub-account organization
+    # id of the sub-account
     attr_accessor :id
 
-    # Name of sub-account organization
+    # Name of the sub-account company
     attr_accessor :company_name
 
-    # Whether organization is active or not
+    # Whether the sub-account is active or not
     attr_accessor :active
 
-    # timestamp when the organization was created
+    # Timestamp when the sub-account was created
     attr_accessor :created_at
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -15,8 +15,6 @@ require 'date'
 module SibApiV3Sdk
   # Task Details
   class Task
-    attr_accessor :first_contact
-
     # Unique task id
     attr_accessor :id
 
@@ -29,84 +27,33 @@ module SibApiV3Sdk
     # Contact ids for contacts linked to this task
     attr_accessor :contacts_ids
 
-    # Contact details for contacts linked to this task
-    attr_accessor :contacts
-
     # Deal ids for deals a task is linked to
     attr_accessor :deals_ids
 
     # Companies ids for companies a task is linked to
     attr_accessor :companies_ids
 
-    # User id to whom task is assigned
-    attr_accessor :assign_to_id
-
-    # Task date/time
-    attr_accessor :date
-
-    # Duration of task
-    attr_accessor :duration
-
-    # Notes added to a task
-    attr_accessor :notes
-
-    # Task marked as done
-    attr_accessor :done
-
-    # Task reminder date/time for a task
-    attr_accessor :reminder
-
-    # Task created date/time
-    attr_accessor :created_at
-
-    # Task update date/time
-    attr_accessor :updated_at
-
-    attr_accessor :refs
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'first_contact' => :'firstContact',
         :'id' => :'id',
         :'task_type_id' => :'taskTypeId',
         :'name' => :'name',
         :'contacts_ids' => :'contactsIds',
-        :'contacts' => :'contacts',
         :'deals_ids' => :'dealsIds',
-        :'companies_ids' => :'companiesIds',
-        :'assign_to_id' => :'assignToId',
-        :'date' => :'date',
-        :'duration' => :'duration',
-        :'notes' => :'notes',
-        :'done' => :'done',
-        :'reminder' => :'reminder',
-        :'created_at' => :'createdAt',
-        :'updated_at' => :'updatedAt',
-        :'refs' => :'refs'
+        :'companies_ids' => :'companiesIds'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'first_contact' => :'Contact',
         :'id' => :'String',
         :'task_type_id' => :'String',
         :'name' => :'String',
         :'contacts_ids' => :'Array<Integer>',
-        :'contacts' => :'Array<Contact>',
         :'deals_ids' => :'Array<String>',
-        :'companies_ids' => :'Array<String>',
-        :'assign_to_id' => :'String',
-        :'date' => :'DateTime',
-        :'duration' => :'Integer',
-        :'notes' => :'String',
-        :'done' => :'BOOLEAN',
-        :'reminder' => :'TaskReminder',
-        :'created_at' => :'DateTime',
-        :'updated_at' => :'DateTime',
-        :'refs' => :'Object'
+        :'companies_ids' => :'Array<String>'
       }
     end
 
@@ -118,10 +65,6 @@ 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?(:'firstContact')
-        self.first_contact = attributes[:'firstContact']
-      end
-
       if attributes.has_key?(:'id')
         self.id = attributes[:'id']
       end
@@ -140,12 +83,6 @@ module SibApiV3Sdk
         end
       end
 
-      if attributes.has_key?(:'contacts')
-        if (value = attributes[:'contacts']).is_a?(Array)
-          self.contacts = value
-        end
-      end
-
       if attributes.has_key?(:'dealsIds')
         if (value = attributes[:'dealsIds']).is_a?(Array)
           self.deals_ids = value
@@ -157,42 +94,6 @@ module SibApiV3Sdk
           self.companies_ids = value
         end
       end
-
-      if attributes.has_key?(:'assignToId')
-        self.assign_to_id = attributes[:'assignToId']
-      end
-
-      if attributes.has_key?(:'date')
-        self.date = attributes[:'date']
-      end
-
-      if attributes.has_key?(:'duration')
-        self.duration = attributes[:'duration']
-      end
-
-      if attributes.has_key?(:'notes')
-        self.notes = attributes[:'notes']
-      end
-
-      if attributes.has_key?(:'done')
-        self.done = attributes[:'done']
-      end
-
-      if attributes.has_key?(:'reminder')
-        self.reminder = attributes[:'reminder']
-      end
-
-      if attributes.has_key?(:'createdAt')
-        self.created_at = attributes[:'createdAt']
-      end
-
-      if attributes.has_key?(:'updatedAt')
-        self.updated_at = attributes[:'updatedAt']
-      end
-
-      if attributes.has_key?(:'refs')
-        self.refs = attributes[:'refs']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -207,10 +108,6 @@ module SibApiV3Sdk
         invalid_properties.push('invalid value for "name", name cannot be nil.')
       end
 
-      if @date.nil?
-        invalid_properties.push('invalid value for "date", date cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -219,7 +116,6 @@ module SibApiV3Sdk
     def valid?
       return false if @task_type_id.nil?
       return false if @name.nil?
-      return false if @date.nil?
       true
     end
 
@@ -228,23 +124,12 @@ module SibApiV3Sdk
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          first_contact == o.first_contact &&
           id == o.id &&
           task_type_id == o.task_type_id &&
           name == o.name &&
           contacts_ids == o.contacts_ids &&
-          contacts == o.contacts &&
           deals_ids == o.deals_ids &&
-          companies_ids == o.companies_ids &&
-          assign_to_id == o.assign_to_id &&
-          date == o.date &&
-          duration == o.duration &&
-          notes == o.notes &&
-          done == o.done &&
-          reminder == o.reminder &&
-          created_at == o.created_at &&
-          updated_at == o.updated_at &&
-          refs == o.refs
+          companies_ids == o.companies_ids
     end
 
     # @see the `==` method
@@ -256,7 +141,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [first_contact, id, task_type_id, name, contacts_ids, contacts, deals_ids, companies_ids, assign_to_id, date, duration, notes, done, reminder, created_at, updated_at, refs].hash
+      [id, task_type_id, name, contacts_ids, deals_ids, companies_ids].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,188 @@
+=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
+  # List of tasks
+  class TaskList
+    # List of tasks
+    attr_accessor :items
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'items' => :'items'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'items' => :'Array<Task>'
+      }
+    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?(:'items')
+        if (value = attributes[:'items']).is_a?(Array)
+          self.items = 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 &&
+          items == o.items
+    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
+      [items].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/task_reminder.rb

@@ -21,7 +21,7 @@ module SibApiV3Sdk
     # Unit of time before reminder is to be sent
     attr_accessor :unit
 
-    # Type of task reminder
+    # Type of task reminder e.g email, push
     attr_accessor :types
 
     class EnumAttributeValidator

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

@@ -18,9 +18,6 @@ module SibApiV3Sdk
     # Id of task type
     attr_accessor :id
 
-    # Icon of task type
-    attr_accessor :icon
-
     # Title of task type
     attr_accessor :title
 
@@ -28,7 +25,6 @@ module SibApiV3Sdk
     def self.attribute_map
       {
         :'id' => :'id',
-        :'icon' => :'icon',
         :'title' => :'title'
       }
     end
@@ -37,7 +33,6 @@ module SibApiV3Sdk
     def self.swagger_types
       {
         :'id' => :'String',
-        :'icon' => :'String',
         :'title' => :'String'
       }
     end
@@ -54,10 +49,6 @@ module SibApiV3Sdk
         self.id = attributes[:'id']
       end
 
-      if attributes.has_key?(:'icon')
-        self.icon = attributes[:'icon']
-      end
-
       if attributes.has_key?(:'title')
         self.title = attributes[:'title']
       end
@@ -82,7 +73,6 @@ module SibApiV3Sdk
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
-          icon == o.icon &&
           title == o.title
     end
 
@@ -95,7 +85,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, icon, title].hash
+      [id, title].hash
     end
 
     # Builds the object from hash

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
@@ -96,6 +96,12 @@ module SibApiV3Sdk
     # Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%.
     attr_accessor :increase_rate
 
+    # Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page.
+    attr_accessor :unsubscription_page_id
+
+    # Mandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form.
+    attr_accessor :update_form_id
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -148,7 +154,9 @@ module SibApiV3Sdk
         :'winner_delay' => :'winnerDelay',
         :'ip_warmup_enable' => :'ipWarmupEnable',
         :'initial_quota' => :'initialQuota',
-        :'increase_rate' => :'increaseRate'
+        :'increase_rate' => :'increaseRate',
+        :'unsubscription_page_id' => :'unsubscriptionPageId',
+        :'update_form_id' => :'updateFormId'
       }
     end
 
@@ -182,7 +190,9 @@ module SibApiV3Sdk
         :'winner_delay' => :'Integer',
         :'ip_warmup_enable' => :'BOOLEAN',
         :'initial_quota' => :'Integer',
-        :'increase_rate' => :'Integer'
+        :'increase_rate' => :'Integer',
+        :'unsubscription_page_id' => :'String',
+        :'update_form_id' => :'String'
       }
     end
 
@@ -313,6 +323,14 @@ module SibApiV3Sdk
       if attributes.has_key?(:'increaseRate')
         self.increase_rate = attributes[:'increaseRate']
       end
+
+      if attributes.has_key?(:'unsubscriptionPageId')
+        self.unsubscription_page_id = attributes[:'unsubscriptionPageId']
+      end
+
+      if attributes.has_key?(:'updateFormId')
+        self.update_form_id = attributes[:'updateFormId']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -444,7 +462,9 @@ module SibApiV3Sdk
           winner_delay == o.winner_delay &&
           ip_warmup_enable == o.ip_warmup_enable &&
           initial_quota == o.initial_quota &&
-          increase_rate == o.increase_rate
+          increase_rate == o.increase_rate &&
+          unsubscription_page_id == o.unsubscription_page_id &&
+          update_form_id == o.update_form_id
     end
 
     # @see the `==` method
@@ -456,7 +476,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [tag, sender, name, html_content, html_url, scheduled_at, subject, reply_to, to_field, recipients, attachment_url, inline_image_activation, mirror_active, recurring, footer, header, utm_campaign, params, send_at_best_time, ab_testing, subject_a, subject_b, split_rule, winner_criteria, winner_delay, ip_warmup_enable, initial_quota, increase_rate].hash
+      [tag, sender, name, html_content, html_url, scheduled_at, subject, reply_to, to_field, recipients, attachment_url, inline_image_activation, mirror_active, recurring, footer, header, utm_campaign, params, send_at_best_time, ab_testing, subject_a, subject_b, split_rule, winner_criteria, winner_delay, ip_warmup_enable, initial_quota, increase_rate, unsubscription_page_id, update_form_id].hash
     end
 
     # Builds the object from hash

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

@@ -13,19 +13,23 @@ Swagger Codegen version: 2.4.19
 require 'date'
 
 module SibApiV3Sdk
-  # List ids to include/exclude from campaign
+  # Segment ids and List ids to include/exclude from campaign
   class UpdateEmailCampaignRecipients
     # List ids which have to be excluded from a campaign
     attr_accessor :exclusion_list_ids
 
-    # Lists Ids to send the campaign to. REQUIRED if already not present in campaign and scheduledAt is not empty
+    # Lists Ids to send the campaign to. Campaign should only be updated with listIds if listIds were used to create it. REQUIRED if already not present in campaign and scheduledAt is not empty
     attr_accessor :list_ids
 
+    # Mandatory if listIds are not used. Campaign should only be updated with segmentIds if segmentIds were used to create it. Segment ids to send the campaign to.
+    attr_accessor :segment_ids
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'exclusion_list_ids' => :'exclusionListIds',
-        :'list_ids' => :'listIds'
+        :'list_ids' => :'listIds',
+        :'segment_ids' => :'segmentIds'
       }
     end
 
@@ -33,7 +37,8 @@ module SibApiV3Sdk
     def self.swagger_types
       {
         :'exclusion_list_ids' => :'Array<Integer>',
-        :'list_ids' => :'Array<Integer>'
+        :'list_ids' => :'Array<Integer>',
+        :'segment_ids' => :'Array<Integer>'
       }
     end
 
@@ -56,6 +61,12 @@ module SibApiV3Sdk
           self.list_ids = value
         end
       end
+
+      if attributes.has_key?(:'segmentIds')
+        if (value = attributes[:'segmentIds']).is_a?(Array)
+          self.segment_ids = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -77,7 +88,8 @@ module SibApiV3Sdk
       return true if self.equal?(o)
       self.class == o.class &&
           exclusion_list_ids == o.exclusion_list_ids &&
-          list_ids == o.list_ids
+          list_ids == o.list_ids &&
+          segment_ids == o.segment_ids
     end
 
     # @see the `==` method
@@ -89,7 +101,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [exclusion_list_ids, list_ids].hash
+      [exclusion_list_ids, list_ids, segment_ids].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)