Class: ClickSendClient::FaxMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/clicksend_client/models/fax_message.rb

Overview

Base model for Fax Messages

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FaxMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/clicksend_client/models/fax_message.rb', line 72

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

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

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

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

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

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

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

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

Instance Attribute Details

#country ⇒ Object

Recipient country.



37
38
39
 
# File 'lib/clicksend_client/models/fax_message.rb', line 37

def country
  @country
end

#custom_string ⇒ Object

Your reference. Will be passed back with all replies and delivery reports.



34
35
36
 
# File 'lib/clicksend_client/models/fax_message.rb', line 34

def custom_string
  @custom_string
end

#from ⇒ Object

Your sender id. Must be a valid fax number.



28
29
30
 
# File 'lib/clicksend_client/models/fax_message.rb', line 28

def from
  @from
end

#from_email ⇒ Object

An email address where the reply should be emailed to.



40
41
42
 
# File 'lib/clicksend_client/models/fax_message.rb', line 40

def from_email
  @from_email
end

#list_id ⇒ Object

Your list ID if sending to a whole list. Can be used instead of ‘to’.



25
26
27
 
# File 'lib/clicksend_client/models/fax_message.rb', line 25

def list_id
  @list_id
end

#schedule ⇒ Object

Leave blank for immediate delivery. Your schedule time in unix format help.clicksend.com/what-is-a-unix-timestamp



31
32
33
 
# File 'lib/clicksend_client/models/fax_message.rb', line 31

def schedule
  @schedule
end

#source ⇒ Object

Your method of sending e.g. ‘wordpress’, ‘php’, ‘c#’.



19
20
21
 
# File 'lib/clicksend_client/models/fax_message.rb', line 19

def source
  @source
end

#to ⇒ Object

Recipient fax number in E.164 format.



22
23
24
 
# File 'lib/clicksend_client/models/fax_message.rb', line 22

def to
  @to
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/clicksend_client/models/fax_message.rb', line 43

def self.attribute_map
  {
    :'source' => :'source',
    :'to' => :'to',
    :'list_id' => :'list_id',
    :'from' => :'from',
    :'schedule' => :'schedule',
    :'custom_string' => :'custom_string',
    :'country' => :'country',
    :'from_email' => :'from_email'
  }
end

.clicksend_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/clicksend_client/models/fax_message.rb', line 57

def self.clicksend_types
  {
    :'source' => :'String',
    :'to' => :'String',
    :'list_id' => :'Integer',
    :'from' => :'String',
    :'schedule' => :'Integer',
    :'custom_string' => :'String',
    :'country' => :'String',
    :'from_email' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/clicksend_client/models/fax_message.rb', line 133

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      source == o.source &&
      to == o.to &&
      list_id == o.list_id &&
      from == o.from &&
      schedule == o.schedule &&
      custom_string == o.custom_string &&
      country == o.country &&
      from_email == o.from_email
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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/clicksend_client/models/fax_message.rb', line 182

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 = ClickSendClient.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



248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/clicksend_client/models/fax_message.rb', line 248

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



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/clicksend_client/models/fax_message.rb', line 161

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.clicksend_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


148
149
150
 
# File 'lib/clicksend_client/models/fax_message.rb', line 148

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



154
155
156
 
# File 'lib/clicksend_client/models/fax_message.rb', line 154

def hash
  [source, to, list_id, from, schedule, custom_string, country, from_email].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



115
116
117
118
119
120
121
122
 
# File 'lib/clicksend_client/models/fax_message.rb', line 115

def list_invalid_properties
  invalid_properties = Array.new
  if @to.nil?
    invalid_properties.push('invalid value for "to", to 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



228
229
230
 
# File 'lib/clicksend_client/models/fax_message.rb', line 228

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



234
235
236
237
238
239
240
241
242
 
# File 'lib/clicksend_client/models/fax_message.rb', line 234

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



222
223
224
 
# File 'lib/clicksend_client/models/fax_message.rb', line 222

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



126
127
128
129
 
# File 'lib/clicksend_client/models/fax_message.rb', line 126

def valid?
  return false if @to.nil?
  true
end