Class: SibApiV3Sdk::RequestSmsRecipientExport

Inherits:
Object
  • Object
show all
Defined in:
lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RequestSmsRecipientExport

Initializes the object

Parameters:

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

    Model attributes in the form of hash



63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb', line 63

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?(:'notifyURL')
    self.notify_url = attributes[:'notifyURL']
  end

  if attributes.has_key?(:'recipientsType')
    self.recipients_type = attributes[:'recipientsType']
  end
end

Instance Attribute Details

#notify_url ⇒ Object

URL that will be called once the export process is finished. For reference, help.sendinblue.com/hc/en-us/articles/360007666479



18
19
20
 
# File 'lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb', line 18

def notify_url
  @notify_url
end

#recipients_type ⇒ Object

Filter the recipients based on how they interacted with the campaign



21
22
23
 
# File 'lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb', line 21

def recipients_type
  @recipients_type
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
 
# File 'lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb', line 46

def self.attribute_map
  {
    :'notify_url' => :'notifyURL',
    :'recipients_type' => :'recipientsType'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
 
# File 'lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb', line 54

def self.swagger_types
  {
    :'notify_url' => :'String',
    :'recipients_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



110
111
112
113
114
115
 
# File 'lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb', line 110

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      notify_url == o.notify_url &&
      recipients_type == o.recipients_type
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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb', line 153

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

#_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



219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb', line 219

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



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb', line 132

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


119
120
121
 
# File 'lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb', line 119

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



125
126
127
 
# File 'lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb', line 125

def hash
  [notify_url, recipients_type].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



80
81
82
83
84
85
86
87
 
# File 'lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb', line 80

def list_invalid_properties
  invalid_properties = Array.new
  if @recipients_type.nil?
    invalid_properties.push('invalid value for "recipients_type", recipients_type cannot be nil.')
  end

  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



199
200
201
 
# File 'lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb', line 199

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



205
206
207
208
209
210
211
212
213
 
# File 'lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb', line 205

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



193
194
195
 
# File 'lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb', line 193

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



91
92
93
94
95
96
 
# File 'lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb', line 91

def valid?
  return false if @recipients_type.nil?
  recipients_type_validator = EnumAttributeValidator.new('String', ['all', 'delivered', 'answered', 'softBounces', 'hardBounces', 'unsubscribed'])
  return false unless recipients_type_validator.valid?(@recipients_type)
  true
end