=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 GetCampaignOverview # ID of the campaign attr_accessor :id # Name of the campaign attr_accessor :name # Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` attr_accessor :subject # Type of campaign attr_accessor :type # Status of the campaign attr_accessor :status # UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) attr_accessor :scheduled_at # Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. attr_accessor :ab_testing # Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` attr_accessor :subject_a # Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` attr_accessor :subject_b # The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` attr_accessor :split_rule # Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` attr_accessor :winner_criteria # The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` attr_accessor :winner_delay # It is true if you have chosen to send your campaign at best time, otherwise it is false attr_accessor :send_at_best_time 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 { :'id' => :'id', :'name' => :'name', :'subject' => :'subject', :'type' => :'type', :'status' => :'status', :'scheduled_at' => :'scheduledAt', :'ab_testing' => :'abTesting', :'subject_a' => :'subjectA', :'subject_b' => :'subjectB', :'split_rule' => :'splitRule', :'winner_criteria' => :'winnerCriteria', :'winner_delay' => :'winnerDelay', :'send_at_best_time' => :'sendAtBestTime' } end # Attribute type mapping. def self.swagger_types { :'id' => :'Integer', :'name' => :'String', :'subject' => :'String', :'type' => :'String', :'status' => :'String', :'scheduled_at' => :'String', :'ab_testing' => :'BOOLEAN', :'subject_a' => :'String', :'subject_b' => :'String', :'split_rule' => :'Integer', :'winner_criteria' => :'String', :'winner_delay' => :'Integer', :'send_at_best_time' => :'BOOLEAN' } 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?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'subject') self.subject = attributes[:'subject'] end if attributes.has_key?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'status') self.status = attributes[:'status'] end if attributes.has_key?(:'scheduledAt') self.scheduled_at = attributes[:'scheduledAt'] end if attributes.has_key?(:'abTesting') self.ab_testing = attributes[:'abTesting'] end if attributes.has_key?(:'subjectA') self.subject_a = attributes[:'subjectA'] end if attributes.has_key?(:'subjectB') self.subject_b = attributes[:'subjectB'] end if attributes.has_key?(:'splitRule') self.split_rule = attributes[:'splitRule'] end if attributes.has_key?(:'winnerCriteria') self.winner_criteria = attributes[:'winnerCriteria'] end if attributes.has_key?(:'winnerDelay') self.winner_delay = attributes[:'winnerDelay'] end if attributes.has_key?(:'sendAtBestTime') self.send_at_best_time = attributes[:'sendAtBestTime'] 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 @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end if @status.nil? invalid_properties.push('invalid value for "status", status 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 @id.nil? return false if @name.nil? return false if @type.nil? type_validator = EnumAttributeValidator.new('String', ['classic', 'trigger']) return false unless type_validator.valid?(@type) return false if @status.nil? status_validator = EnumAttributeValidator.new('String', ['draft', 'sent', 'archive', 'queued', 'suspended', 'in_process']) return false unless status_validator.valid?(@status) true end # Custom attribute writer method checking allowed values (enum). # @param [Object] type Object to be assigned def type=(type) validator = EnumAttributeValidator.new('String', ['classic', 'trigger']) unless validator.valid?(type) fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.' end @type = type end # Custom attribute writer method checking allowed values (enum). # @param [Object] status Object to be assigned def status=(status) validator = EnumAttributeValidator.new('String', ['draft', 'sent', 'archive', 'queued', 'suspended', 'in_process']) unless validator.valid?(status) fail ArgumentError, 'invalid value for "status", must be one of #{validator.allowable_values}.' end @status = status 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 && id == o.id && name == o.name && subject == o.subject && type == o.type && status == o.status && scheduled_at == o.scheduled_at && ab_testing == o.ab_testing && subject_a == o.subject_a && subject_b == o.subject_b && split_rule == o.split_rule && winner_criteria == o.winner_criteria && winner_delay == o.winner_delay && send_at_best_time == o.send_at_best_time 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 [id, name, subject, type, status, scheduled_at, ab_testing, subject_a, subject_b, split_rule, winner_criteria, winner_delay, send_at_best_time].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<(?.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?.+?), (?.+)>\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