sib-api-v3-sdk 5.5.0 → 7.4.0

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

@@ -6,7 +6,7 @@
 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.12
+Swagger Codegen version: 2.4.18
 
 =end
 
@@ -19,6 +19,16 @@ module SibApiV3Sdk
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+
+    # Set custom user_agent if explicitly passed in api
+    # default will still remain Swagger-Codegen/#{VERSION}/ruby
+    def setUserAgent(user_agent)
+      @user_agent = user_agent
+      if user_agent.is_a?(String) && user_agent.downcase.start_with?('sendinblue_')
+        @api_client.default_headers['User-Agent'] = @user_agent
+      end
+    end
+    
     # Get all your SMS activity (unaggregated events)
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Number of documents per page (default to 50)
@@ -29,6 +39,7 @@ module SibApiV3Sdk
     # @option opts [String] :phone_number Filter the report for a specific phone number
     # @option opts [String] :event Filter the report for specific events
     # @option opts [String] :tags Filter the report for specific tags passed as a serialized urlencoded array
+    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
     # @return [GetSmsEventReport]
     def get_sms_events(opts = {})
       data, _status_code, _headers = get_sms_events_with_http_info(opts)
@@ -45,6 +56,7 @@ module SibApiV3Sdk
     # @option opts [String] :phone_number Filter the report for a specific phone number
     # @option opts [String] :event Filter the report for specific events
     # @option opts [String] :tags Filter the report for specific tags passed as a serialized urlencoded array
+    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
     # @return [Array<(GetSmsEventReport, Fixnum, Hash)>] GetSmsEventReport data, response status code and response headers
     def get_sms_events_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -57,6 +69,9 @@ module SibApiV3Sdk
       if @api_client.config.client_side_validation && opts[:'event'] && !['bounces', 'hardBounces', 'softBounces', 'delivered', 'sent', 'accepted', 'unsubscription', 'replies', 'blocked'].include?(opts[:'event'])
         fail ArgumentError, 'invalid value for "event", must be one of bounces, hardBounces, softBounces, delivered, sent, accepted, unsubscription, replies, blocked'
       end
+      if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
+        fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
+      end
       # resource path
       local_var_path = '/transactionalSMS/statistics/events'
 
@@ -70,6 +85,7 @@ module SibApiV3Sdk
       query_params[:'phoneNumber'] = opts[:'phone_number'] if !opts[:'phone_number'].nil?
       query_params[:'event'] = opts[:'event'] if !opts[:'event'].nil?
       query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
 
       # header parameters
       header_params = {}
@@ -160,6 +176,7 @@ module SibApiV3Sdk
     # @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
     # @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39;
     # @option opts [String] :tag Filter on a tag
+    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
     # @return [GetTransacSmsReport]
     def get_transac_sms_report(opts = {})
       data, _status_code, _headers = get_transac_sms_report_with_http_info(opts)
@@ -172,11 +189,15 @@ module SibApiV3Sdk
     # @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
     # @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39;
     # @option opts [String] :tag Filter on a tag
+    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
     # @return [Array<(GetTransacSmsReport, Fixnum, Hash)>] GetTransacSmsReport data, response status code and response headers
     def get_transac_sms_report_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: TransactionalSMSApi.get_transac_sms_report ...'
       end
+      if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
+        fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
+      end
       # resource path
       local_var_path = '/transactionalSMS/statistics/reports'
 
@@ -186,6 +207,7 @@ module SibApiV3Sdk
       query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
       query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
       query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
 
       # header parameters
       header_params = {}

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

@@ -6,7 +6,7 @@
 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.12
+Swagger Codegen version: 2.4.18
 
 =end
 
@@ -19,6 +19,16 @@ module SibApiV3Sdk
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+
+    # Set custom user_agent if explicitly passed in api
+    # default will still remain Swagger-Codegen/#{VERSION}/ruby
+    def setUserAgent(user_agent)
+      @user_agent = user_agent
+      if user_agent.is_a?(String) && user_agent.downcase.start_with?('sendinblue_')
+        @api_client.default_headers['User-Agent'] = @user_agent
+      end
+    end
+    
     # Create a webhook
     # @param create_webhook Values to create a webhook
     # @param [Hash] opts the optional parameters

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

@@ -6,7 +6,7 @@
 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.12
+Swagger Codegen version: 2.4.18
 
 =end
 
@@ -15,7 +15,7 @@ require 'json'
 require 'logger'
 require 'tempfile'
 require 'typhoeus'
-require 'uri'
+require 'addressable/uri'
 
 module SibApiV3Sdk
   class ApiClient
@@ -63,7 +63,7 @@ module SibApiV3Sdk
                             :message => response.return_message)
         else
           fail ApiError.new(:code => response.code,
-                            :response_headers => response.headers,
+                            :response_headers => response.headers.to_h,
                             :response_body => response.body),
                response.status_message
         end
@@ -112,6 +112,8 @@ module SibApiV3Sdk
         :verbose => @config.debugging
       }
 
+      req_opts.merge!(multipart: true) if header_params['Content-Type'].start_with? "multipart/"
+
       # set custom cert, if provided
       req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
 
@@ -264,7 +266,7 @@ module SibApiV3Sdk
     def build_request_url(path)
       # Add leading and trailing slashes to path
       path = "/#{path}".gsub(/\/+/, '/')
-      URI.encode(@config.base_url + path)
+      Addressable::URI.encode(@config.base_url + path)
     end
 
     # Builds the HTTP request body

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

@@ -6,7 +6,7 @@
 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.12
+Swagger Codegen version: 2.4.18
 
 =end
 

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

@@ -6,11 +6,11 @@
 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.12
+Swagger Codegen version: 2.4.18
 
 =end
 
-require 'uri'
+require 'addressable/uri'
 
 module SibApiV3Sdk
   class Configuration
@@ -175,7 +175,7 @@ module SibApiV3Sdk
 
     def base_url
       url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
-      URI.encode(url)
+      Addressable::URI.encode(url)
     end
 
     # Gets API key (with prefix if set).

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

@@ -6,7 +6,7 @@
 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.12
+Swagger Codegen version: 2.4.18
 
 =end
 
@@ -32,6 +32,10 @@ module SibApiV3Sdk
     # Open/Click rate for the winner version
     attr_accessor :winning_version_rate
 
+    attr_accessor :statistics
+
+    attr_accessor :clicked_links
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -62,7 +66,9 @@ module SibApiV3Sdk
         :'winning_subject_line' => :'winningSubjectLine',
         :'open_rate' => :'openRate',
         :'click_rate' => :'clickRate',
-        :'winning_version_rate' => :'winningVersionRate'
+        :'winning_version_rate' => :'winningVersionRate',
+        :'statistics' => :'statistics',
+        :'clicked_links' => :'clickedLinks'
       }
     end
 
@@ -74,7 +80,9 @@ module SibApiV3Sdk
         :'winning_subject_line' => :'String',
         :'open_rate' => :'String',
         :'click_rate' => :'String',
-        :'winning_version_rate' => :'String'
+        :'winning_version_rate' => :'String',
+        :'statistics' => :'AbTestCampaignResultStatistics',
+        :'clicked_links' => :'AbTestCampaignResultClickedLinks'
       }
     end
 
@@ -109,6 +117,14 @@ module SibApiV3Sdk
       if attributes.has_key?(:'winningVersionRate')
         self.winning_version_rate = attributes[:'winningVersionRate']
       end
+
+      if attributes.has_key?(:'statistics')
+        self.statistics = attributes[:'statistics']
+      end
+
+      if attributes.has_key?(:'clickedLinks')
+        self.clicked_links = attributes[:'clickedLinks']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -158,7 +174,9 @@ module SibApiV3Sdk
           winning_subject_line == o.winning_subject_line &&
           open_rate == o.open_rate &&
           click_rate == o.click_rate &&
-          winning_version_rate == o.winning_version_rate
+          winning_version_rate == o.winning_version_rate &&
+          statistics == o.statistics &&
+          clicked_links == o.clicked_links
     end
 
     # @see the `==` method
@@ -170,7 +188,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [winning_version, winning_criteria, winning_subject_line, open_rate, click_rate, winning_version_rate].hash
+      [winning_version, winning_criteria, winning_subject_line, open_rate, click_rate, winning_version_rate, statistics, clicked_links].hash
     end
 
     # Builds the object from hash
@@ -180,7 +198,7 @@ module SibApiV3Sdk
       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
+          # 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) })
@@ -276,5 +294,6 @@ module SibApiV3Sdk
         value
       end
     end
+
   end
 end

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

@@ -0,0 +1,203 @@
+=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.18
+
+=end
+
+require 'date'
+
+module SibApiV3Sdk
+  class AbTestCampaignResultClickedLinks
+    attr_accessor :version_a
+
+    attr_accessor :version_b
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'version_a' => :'Version A',
+        :'version_b' => :'Version B'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'version_a' => :'AbTestVersionClicks',
+        :'version_b' => :'AbTestVersionClicks'
+      }
+    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?(:'Version A')
+        self.version_a = attributes[:'Version A']
+      end
+
+      if attributes.has_key?(:'Version B')
+        self.version_b = attributes[:'Version B']
+      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 @version_a.nil?
+        invalid_properties.push('invalid value for "version_a", version_a cannot be nil.')
+      end
+
+      if @version_b.nil?
+        invalid_properties.push('invalid value for "version_b", version_b 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 @version_a.nil?
+      return false if @version_b.nil?
+      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 &&
+          version_a == o.version_a &&
+          version_b == o.version_b
+    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
+      [version_a, version_b].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