Class: BrevoRuby::CreateEmailCampaignRecipients

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo-ruby/models/create_email_campaign_recipients.rb

Overview

Segment ids and List ids to include/exclude from campaign

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateEmailCampaignRecipients

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/brevo-ruby/models/create_email_campaign_recipients.rb', line 47

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?(:'exclusionListIds')
    if (value = attributes[:'exclusionListIds']).is_a?(Array)
      self.exclusion_list_ids = value
    end
  end

  if attributes.has_key?(:'listIds')
    if (value = attributes[:'listIds']).is_a?(Array)
      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

Instance Attribute Details

#exclusion_list_ids ⇒ Object

List ids to exclude from the campaign



19
20
21
 
# File 'lib/brevo-ruby/models/create_email_campaign_recipients.rb', line 19

def exclusion_list_ids
  @exclusion_list_ids
end

#list_ids ⇒ Object

Mandatory if scheduledAt is not empty. List Ids to send the campaign to



22
23
24
 
# File 'lib/brevo-ruby/models/create_email_campaign_recipients.rb', line 22

def list_ids
  @list_ids
end

#segment_ids ⇒ Object

Mandatory if listIds are not used. Segment ids to send the campaign to.



25
26
27
 
# File 'lib/brevo-ruby/models/create_email_campaign_recipients.rb', line 25

def segment_ids
  @segment_ids
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



28
29
30
31
32
33
34
 
# File 'lib/brevo-ruby/models/create_email_campaign_recipients.rb', line 28

def self.attribute_map
  {
    :'exclusion_list_ids' => :'exclusionListIds',
    :'list_ids' => :'listIds',
    :'segment_ids' => :'segmentIds'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
 
# File 'lib/brevo-ruby/models/create_email_campaign_recipients.rb', line 37

def self.swagger_types
  {
    :'exclusion_list_ids' => :'Array<Integer>',
    :'list_ids' => :'Array<Integer>',
    :'segment_ids' => :'Array<Integer>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



87
88
89
90
91
92
93
 
# File 'lib/brevo-ruby/models/create_email_campaign_recipients.rb', line 87

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      exclusion_list_ids == o.exclusion_list_ids &&
      list_ids == o.list_ids &&
      segment_ids == o.segment_ids
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/brevo-ruby/models/create_email_campaign_recipients.rb', line 131

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 = BrevoRuby.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/brevo-ruby/models/create_email_campaign_recipients.rb', line 197

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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/brevo-ruby/models/create_email_campaign_recipients.rb', line 110

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


97
98
99
 
# File 'lib/brevo-ruby/models/create_email_campaign_recipients.rb', line 97

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



103
104
105
 
# File 'lib/brevo-ruby/models/create_email_campaign_recipients.rb', line 103

def hash
  [exclusion_list_ids, list_ids, segment_ids].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



74
75
76
77
 
# File 'lib/brevo-ruby/models/create_email_campaign_recipients.rb', line 74

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



177
178
179
 
# File 'lib/brevo-ruby/models/create_email_campaign_recipients.rb', line 177

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



183
184
185
186
187
188
189
190
191
 
# File 'lib/brevo-ruby/models/create_email_campaign_recipients.rb', line 183

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



171
172
173
 
# File 'lib/brevo-ruby/models/create_email_campaign_recipients.rb', line 171

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



81
82
83
 
# File 'lib/brevo-ruby/models/create_email_campaign_recipients.rb', line 81

def valid?
  true
end