Class: CloudmersiveConvertApiClient::DocxTemplateOperation

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-convert-api-client/models/docx_template_operation.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocxTemplateOperation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/cloudmersive-convert-api-client/models/docx_template_operation.rb', line 68

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

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

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

Instance Attribute Details

#action ⇒ Object

Operation action to take; possible values are "Replace"



18
19
20
 
# File 'lib/cloudmersive-convert-api-client/models/docx_template_operation.rb', line 18

def action
  @action
end

#match_against ⇒ Object

For Replace operations, the string to match against (to be replaced with ReplaceWith string)



21
22
23
 
# File 'lib/cloudmersive-convert-api-client/models/docx_template_operation.rb', line 21

def match_against
  @match_against
end

#replace_with ⇒ Object

For Replace operations, the string to Replace the original string with



24
25
26
 
# File 'lib/cloudmersive-convert-api-client/models/docx_template_operation.rb', line 24

def replace_with
  @replace_with
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
 
# File 'lib/cloudmersive-convert-api-client/models/docx_template_operation.rb', line 49

def self.attribute_map
  {
    :'action' => :'Action',
    :'match_against' => :'MatchAgainst',
    :'replace_with' => :'ReplaceWith'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
 
# File 'lib/cloudmersive-convert-api-client/models/docx_template_operation.rb', line 58

def self.swagger_types
  {
    :'action' => :'Integer',
    :'match_against' => :'String',
    :'replace_with' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



114
115
116
117
118
119
120
 
# File 'lib/cloudmersive-convert-api-client/models/docx_template_operation.rb', line 114

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



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
194
 
# File 'lib/cloudmersive-convert-api-client/models/docx_template_operation.rb', line 158

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



224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/cloudmersive-convert-api-client/models/docx_template_operation.rb', line 224

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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/cloudmersive-convert-api-client/models/docx_template_operation.rb', line 137

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


124
125
126
 
# File 'lib/cloudmersive-convert-api-client/models/docx_template_operation.rb', line 124

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



130
131
132
 
# File 'lib/cloudmersive-convert-api-client/models/docx_template_operation.rb', line 130

def hash
  [action, match_against, replace_with].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



89
90
91
92
 
# File 'lib/cloudmersive-convert-api-client/models/docx_template_operation.rb', line 89

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



204
205
206
 
# File 'lib/cloudmersive-convert-api-client/models/docx_template_operation.rb', line 204

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



210
211
212
213
214
215
216
217
218
 
# File 'lib/cloudmersive-convert-api-client/models/docx_template_operation.rb', line 210

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



198
199
200
 
# File 'lib/cloudmersive-convert-api-client/models/docx_template_operation.rb', line 198

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



96
97
98
99
100
 
# File 'lib/cloudmersive-convert-api-client/models/docx_template_operation.rb', line 96

def valid?
  action_validator = EnumAttributeValidator.new('Integer', ['1'])
  return false unless action_validator.valid?(@action)
  true
end