Class: PureCloud::SheetSchema

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/sheet_schema.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SheetSchema

Returns a new instance of SheetSchema.



71
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
 
# File 'lib/purecloud/models/sheet_schema.rb', line 71

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'HeaderRow']
    self.header_row = attributes[:'HeaderRow']
  end
  
  if attributes[:'DataRow']
    self.data_row = attributes[:'DataRow']
  end
  
  if attributes[:'HeaderMappings']
    if (value = attributes[:'HeaderMappings']).is_a?(Array)
      self.header_mappings = value
    end
  end
  
  if attributes[:'RateType']
    self.rate_type = attributes[:'RateType']
  end
  
  if attributes[:'SheetNumber']
    self.sheet_number = attributes[:'SheetNumber']
  end
  
  if attributes[:'DateFormat']
    self.date_format = attributes[:'DateFormat']
  end
  
end

Instance Attribute Details

#data_row ⇒ Object

Row number of the first line of data in the sheet. This is zero indexed (i.e. 0 is row 1)



25
26
27
 
# File 'lib/purecloud/models/sheet_schema.rb', line 25

def data_row
  @data_row
end

#date_format ⇒ Object

A date format that represents the date time stamp you want to parse. This is based on the reference time of Mon Jan 2 15:04:05 MST 2006. For example, if you had the date 13-OCT-2015, this parameter should be 02-Jan-2006. As another example, if you have the date 2014-09-20, this parameter should be 2006-01-02.



37
38
39
 
# File 'lib/purecloud/models/sheet_schema.rb', line 37

def date_format
  @date_format
end

#header_mappings ⇒ Object

XLSX sheet header name to object name mappings. For example, "ROUTE_TEL_PREFIX" to "Prefix" might be one such mapping.



28
29
30
 
# File 'lib/purecloud/models/sheet_schema.rb', line 28

def header_mappings
  @header_mappings
end

#header_row ⇒ Object

Row number for the XLSX sheet’s headers. This is zero indexed (i.e. 0 is row 1).



22
23
24
 
# File 'lib/purecloud/models/sheet_schema.rb', line 22

def header_row
  @header_row
end

#rate_type ⇒ Object

Rate type for the sheet.



31
32
33
 
# File 'lib/purecloud/models/sheet_schema.rb', line 31

def rate_type
  @rate_type
end

#sheet_number ⇒ Object

Sheet number within the XLSX file. This is zero indexed (i.e. 0 is page 1).



34
35
36
 
# File 'lib/purecloud/models/sheet_schema.rb', line 34

def sheet_number
  @sheet_number
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/purecloud/models/sheet_schema.rb', line 40

def self.attribute_map
  {
    
    :'header_row' => :'HeaderRow',
    
    :'data_row' => :'DataRow',
    
    :'header_mappings' => :'HeaderMappings',
    
    :'rate_type' => :'RateType',
    
    :'sheet_number' => :'SheetNumber',
    
    :'date_format' => :'DateFormat'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/purecloud/models/sheet_schema.rb', line 59

def self.swagger_types
  {
    :'header_row' => :'Integer',
    :'data_row' => :'Integer',
    :'header_mappings' => :'Hash<String, String>',
    :'rate_type' => :'String',
    :'sheet_number' => :'Integer',
    :'date_format' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



116
117
118
119
120
121
122
123
124
125
 
# File 'lib/purecloud/models/sheet_schema.rb', line 116

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      header_row == o.header_row &&
      data_row == o.data_row &&
      header_mappings == o.header_mappings &&
      rate_type == o.rate_type &&
      sheet_number == o.sheet_number &&
      date_format == o.date_format
end

#_deserialize(type, value) ⇒ Object 



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
193
 
# File 'lib/purecloud/models/sheet_schema.rb', line 157

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 =~ /^(true|t|yes|y|1)$/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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

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



217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/purecloud/models/sheet_schema.rb', line 217

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

build the object from hash



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/purecloud/models/sheet_schema.rb', line 138

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method


128
129
130
 
# File 'lib/purecloud/models/sheet_schema.rb', line 128

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



133
134
135
 
# File 'lib/purecloud/models/sheet_schema.rb', line 133

def hash
  [header_row, data_row, header_mappings, rate_type, sheet_number, date_format].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



200
201
202
 
# File 'lib/purecloud/models/sheet_schema.rb', line 200

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



205
206
207
208
209
210
211
212
213
 
# File 'lib/purecloud/models/sheet_schema.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 ⇒ Object 



195
196
197
 
# File 'lib/purecloud/models/sheet_schema.rb', line 195

def to_s
  to_hash.to_s
end