Class: AsposeEmailCloud::ClientMessageBaseRequest

Inherits:
ClientAccountBaseRequest show all
Defined in:
lib/aspose-email-cloud/models/client_message_base_request.rb

Overview

Email client message request.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(account_location: nil, message_id: nil) ⇒ ClientMessageBaseRequest

Initializes the object



56
57
58
59
60
61
 
# File 'lib/aspose-email-cloud/models/client_message_base_request.rb', line 56

def initialize(
  account_location: nil,
  message_id: nil)
  self. =  if 
  self.message_id = message_id if message_id
end

Instance Attribute Details

#account_location ⇒ StorageFileLocation

Email client account configuration location on storage.



33
34
35
 
# File 'lib/aspose-email-cloud/models/client_message_base_request.rb', line 33

def 
  @account_location
end

#message_id ⇒ String

Message identifier.



36
37
38
 
# File 'lib/aspose-email-cloud/models/client_message_base_request.rb', line 36

def message_id
  @message_id
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
 
# File 'lib/aspose-email-cloud/models/client_message_base_request.rb', line 38

def self.attribute_map
  {
    :'account_location' => :'accountLocation',
    :'message_id' => :'messageId'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
 
# File 'lib/aspose-email-cloud/models/client_message_base_request.rb', line 46

def self.swagger_types
  {
    :'account_location' => :'StorageFileLocation',
    :'message_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



107
108
109
110
111
112
 
# File 'lib/aspose-email-cloud/models/client_message_base_request.rb', line 107

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      message_id == o.message_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



152
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
190
191
192
 
# File 'lib/aspose-email-cloud/models/client_message_base_request.rb', line 152

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
    sub_type = value[:type] || value[:discriminator] || type
    if AsposeEmailCloud.const_defined?(sub_type)
      type = sub_type
    end
    temp_model = AsposeEmailCloud.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



222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/aspose-email-cloud/models/client_message_base_request.rb', line 222

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



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/aspose-email-cloud/models/client_message_base_request.rb', line 129

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    attribute_key = self.class.attribute_map[key]
    attribute_key = (attribute_key[0, 1].downcase + attribute_key[1..-1]).to_sym
    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[attribute_key].is_a?(Array)
        self.send("#{key}=", attributes[attribute_key].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_key].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_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

See Also:

  • `==` method


116
117
118
 
# File 'lib/aspose-email-cloud/models/client_message_base_request.rb', line 116

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



122
123
124
 
# File 'lib/aspose-email-cloud/models/client_message_base_request.rb', line 122

def hash
  [, message_id].hash
end

#list_invalid_properties ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/aspose-email-cloud/models/client_message_base_request.rb', line 65

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

  if @message_id.nil?
    invalid_properties.push('invalid value for "message_id", message_id cannot be nil.')
  end

  if @message_id.to_s.length < 1
    invalid_properties.push('invalid value for "message_id", the character length must be great than or equal to 1.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



202
203
204
 
# File 'lib/aspose-email-cloud/models/client_message_base_request.rb', line 202

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



208
209
210
211
212
213
214
215
216
 
# File 'lib/aspose-email-cloud/models/client_message_base_request.rb', line 208

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



196
197
198
 
# File 'lib/aspose-email-cloud/models/client_message_base_request.rb', line 196

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



84
85
86
87
88
89
 
# File 'lib/aspose-email-cloud/models/client_message_base_request.rb', line 84

def valid?
  return false if @account_location.nil?
  return false if @message_id.nil?
  return false if @message_id.to_s.length < 1
  true
end