sib-api-v3-sdk 4.0.1 → 5.0.0

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

@@ -21,7 +21,7 @@ module SibApiV3Sdk
     # Base64 encoded chunk data of the attachment generated on the fly
     attr_accessor :content
 
-    # Required for content. Name of the attachment
+    # Required if content is passed. Name of the attachment
     attr_accessor :name
 
 

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

@@ -13,7 +13,7 @@ Swagger Codegen version: 2.3.1
 require 'date'
 
 module SibApiV3Sdk
-  # Email on which transactional mail recipients will be able to reply to
+  # Email (required), along with name (optional), on which transactional mail recipients will be able to reply back. For example, {'email':'ann6533@example.com', 'name':'Ann'}.
   class SendSmtpEmailReplyTo
     # Email address in reply to
     attr_accessor :email

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

@@ -13,12 +13,12 @@ Swagger Codegen version: 2.3.1
 require 'date'
 
 module SibApiV3Sdk
-  # Sender from which emails are sent. Mandatory if 'templateId' is not passed
+  # Mandatory if 'templateId' is not passed. Pass name (optional) and email of sender from which emails will be sent. For example, {'name':'Mary from MyShop', 'email':'no-reply@myshop.com'}
   class SendSmtpEmailSender
-    # Sender Name from which the emails are sent
+    # Name of the sender from which the emails will be sent
     attr_accessor :name
 
-    # Sender Email from which the emails are sent
+    # Email of the sender from which the emails will be sent
     attr_accessor :email
 
 

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

@@ -15,7 +15,7 @@ require 'date'
 module SibApiV3Sdk
 
   class SendTestEmail
-    # If empty the test email will be sent to your entire test list. Use this field to send it to specific addresses in your list.
+    # List of the email addresses of the recipients whom you wish to send the test mail. If left empty, the test mail will be sent to your entire test list.
     attr_accessor :email_to
 
 

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

@@ -15,10 +15,10 @@ require 'date'
 module SibApiV3Sdk
 
   class UpdateAttribute
-    # Value of the attribute. Use only if the attribute's category is calculated or global
+    # Value of the attribute to update. Use only if the attribute's category is 'calculated' or 'global'
     attr_accessor :value
 
-    # Values that the attribute can take. Use only if the attribute's category is category
+    # List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}]
     attr_accessor :enumeration
 
 

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

@@ -15,12 +15,13 @@ require 'date'
 module SibApiV3Sdk
 
   class UpdateContact
+    # Pass the set of attributes to be updated. These attributes must be present in your account. For eg. {'FNAME':'Ellie', 'LNAME':'Roger'}
     attr_accessor :attributes
 
-    # Blacklist the contact for emails (emailBlacklisted = true)
+    # Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true)
     attr_accessor :email_blacklisted
 
-    # Blacklist the contact for SMS (smsBlacklisted = true)
+    # 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
@@ -48,7 +49,7 @@ module SibApiV3Sdk
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'attributes' => :'Hash<String, String>',
+        :'attributes' => :'Object',
         :'email_blacklisted' => :'BOOLEAN',
         :'sms_blacklisted' => :'BOOLEAN',
         :'list_ids' => :'Array<Integer>',
@@ -66,9 +67,7 @@ module SibApiV3Sdk
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
       if attributes.has_key?(:'attributes')
-        if (value = attributes[:'attributes']).is_a?(Hash)
-          self.attributes = value
-        end
+        self.attributes = attributes[:'attributes']
       end
 
       if attributes.has_key?(:'emailBlacklisted')

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

@@ -13,7 +13,7 @@ Swagger Codegen version: 2.3.1
 require 'date'
 
 module SibApiV3Sdk
-
+  # List ids to include/exclude from campaign
   class UpdateEmailCampaignRecipients
     # List ids which have to be excluded from a campaign
     attr_accessor :exclusion_list_ids

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

@@ -13,7 +13,7 @@ Swagger Codegen version: 2.3.1
 require 'date'
 
 module SibApiV3Sdk
-
+  # Sender details including email and/or name. For example {'name':'xyz' , 'email':'example@abc.com'}
   class UpdateEmailCampaignSender
     # Sender Name from which the campaign emails are sent
     attr_accessor :name

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

@@ -15,10 +15,10 @@ require 'date'
 module SibApiV3Sdk
 
   class UpdateList
-    # Name of the list. Only one parameter can be update at once
+    # Name of the list. Either of the two parameters (name, folderId) can be updated at a time.
     attr_accessor :name
 
-    # Id of the folder in which to move the list. Only one parameter can updated at once
+    # Id of the folder in which the list is to be moved. Either of the two parameters (name, folderId) can be updated at a time.
     attr_accessor :folder_id
 
 

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

@@ -13,7 +13,7 @@ Swagger Codegen version: 2.3.1
 require 'date'
 
 module SibApiV3Sdk
-
+  # Sender details including email and/or name. For example {'name':'xyz' , 'email':'example@abc.com'}
   class UpdateSmtpTemplateSender
     # Name of the sender
     attr_accessor :name

data/lib/sib-api-v3-sdk/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.3.1
 =end
 
 module SibApiV3Sdk
-  VERSION = "4.0.1"
+  VERSION = "5.0.0"
 end

data/spec/api/smtp_api_spec.rb

@@ -149,7 +149,7 @@ describe 'SMTPApi' do
 
   # unit tests for send_template
   # Send a template
-  # 
+  # This endpoint is deprecated. Prefer v3/smtp/email instead.
   # @param template_id Id of the template
   # @param send_email 
   # @param [Hash] opts the optional parameters

data/spec/models/get_extended_campaign_stats_spec.rb

@@ -32,6 +32,12 @@ describe 'GetExtendedCampaignStats' do
       expect(@instance).to be_instance_of(SibApiV3Sdk::GetExtendedCampaignStats)
     end
   end
+  describe 'test attribute "global_stats"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "campaign_stats"' do
     it 'should work' do
        # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/models/request_contact_import_spec.rb

@@ -62,5 +62,23 @@ describe 'RequestContactImport' do
     end
   end
 
+  describe 'test attribute "email_blacklist"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "sms_blacklist"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "update_existing_contacts"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end
 

data/spec/models/send_email_spec.rb

@@ -80,5 +80,11 @@ describe 'SendEmail' do
     end
   end
 
+  describe 'test attribute "tags"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end
 

data/spec/models/send_smtp_email_spec.rb

@@ -104,5 +104,11 @@ describe 'SendSmtpEmail' do
     end
   end
 
+  describe 'test attribute "tags"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sib-api-v3-sdk
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 5.0.0
 platform: ruby
 authors:
 - SendinBlue Developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-16 00:00:00.000000000 Z
+date: 2018-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -266,7 +266,6 @@ files:
 - docs/GetExtendedCampaignOverview.md
 - docs/GetExtendedCampaignOverviewSender.md
 - docs/GetExtendedCampaignStats.md
-- docs/GetExtendedCampaignStatsLinksStats.md
 - docs/GetExtendedClient.md
 - docs/GetExtendedClientAddress.md
 - docs/GetExtendedContactDetails.md
@@ -440,7 +439,6 @@ files:
 - lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb
 - lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb
 - lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb
-- lib/sib-api-v3-sdk/models/get_extended_campaign_stats_links_stats.rb
 - lib/sib-api-v3-sdk/models/get_extended_client.rb
 - lib/sib-api-v3-sdk/models/get_extended_client_address.rb
 - lib/sib-api-v3-sdk/models/get_extended_contact_details.rb
@@ -605,7 +603,6 @@ files:
 - spec/models/get_email_event_report_spec.rb
 - spec/models/get_extended_campaign_overview_sender_spec.rb
 - spec/models/get_extended_campaign_overview_spec.rb
-- spec/models/get_extended_campaign_stats_links_stats_spec.rb
 - spec/models/get_extended_campaign_stats_spec.rb
 - spec/models/get_extended_client_address_spec.rb
 - spec/models/get_extended_client_spec.rb
@@ -795,7 +792,6 @@ test_files:
 - spec/models/get_email_event_report_spec.rb
 - spec/models/get_extended_campaign_overview_sender_spec.rb
 - spec/models/get_extended_campaign_overview_spec.rb
-- spec/models/get_extended_campaign_stats_links_stats_spec.rb
 - spec/models/get_extended_campaign_stats_spec.rb
 - spec/models/get_extended_client_address_spec.rb
 - spec/models/get_extended_client_spec.rb

data/docs/GetExtendedCampaignStatsLinksStats.md

@@ -1,8 +0,0 @@
-# SibApiV3Sdk::GetExtendedCampaignStatsLinksStats
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**nb_click** | **Integer** | Number of clicks for the link | 
-
-

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

@@ -1,194 +0,0 @@
-=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  | 
-
-OpenAPI spec version: 3.0.0
-Contact: contact@sendinblue.com
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
-
-=end
-
-require 'date'
-
-module SibApiV3Sdk
-  # Statistics about the clicked links
-  class GetExtendedCampaignStatsLinksStats
-    # Number of clicks for the link
-    attr_accessor :nb_click
-
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'nb_click' => :'nbClick'
-      }
-    end
-
-    # Attribute type mapping.
-    def self.swagger_types
-      {
-        :'nb_click' => :'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?(:'nbClick')
-        self.nb_click = attributes[:'nbClick']
-      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 @nb_click.nil?
-        invalid_properties.push("invalid value for 'nb_click', nb_click cannot be nil.")
-      end
-
-      return 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 @nb_click.nil?
-      return 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 &&
-          nb_click == o.nb_click
-    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
-      [nb_click].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 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