Class: CloudmersiveConvertApiClient::DocxSetHeaderRequest

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

Overview

Input to a set-header command

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocxSetHeaderRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/cloudmersive-convert-api-client/models/docx_set_header_request.rb', line 47

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

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

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

Instance Attribute Details

#header_to_apply ⇒ Object

Header to apply



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

def header_to_apply
  @header_to_apply
end

#input_file_bytes ⇒ Object

Optional: Bytes of the input file to operate on



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

def input_file_bytes
  @input_file_bytes
end

#input_file_url ⇒ Object

Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).



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

def input_file_url
  @input_file_url
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
 
# File 'lib/cloudmersive-convert-api-client/models/docx_set_header_request.rb', line 28

def self.attribute_map
  {
    :'input_file_bytes' => :'InputFileBytes',
    :'input_file_url' => :'InputFileUrl',
    :'header_to_apply' => :'HeaderToApply'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
 
# File 'lib/cloudmersive-convert-api-client/models/docx_set_header_request.rb', line 37

def self.swagger_types
  {
    :'input_file_bytes' => :'String',
    :'input_file_url' => :'String',
    :'header_to_apply' => :'DocxHeader'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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



140
141
142
143
144
145
146
147
148
149
150
151
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
 
# File 'lib/cloudmersive-convert-api-client/models/docx_set_header_request.rb', line 140

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



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

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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/cloudmersive-convert-api-client/models/docx_set_header_request.rb', line 119

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


106
107
108
 
# File 'lib/cloudmersive-convert-api-client/models/docx_set_header_request.rb', line 106

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



112
113
114
 
# File 'lib/cloudmersive-convert-api-client/models/docx_set_header_request.rb', line 112

def hash
  [input_file_bytes, input_file_url, header_to_apply].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



68
69
70
71
72
73
74
75
 
# File 'lib/cloudmersive-convert-api-client/models/docx_set_header_request.rb', line 68

def list_invalid_properties
  invalid_properties = Array.new
  if !@input_file_bytes.nil? && @input_file_bytes !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
    invalid_properties.push('invalid value for "input_file_bytes", must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/.')
  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



186
187
188
 
# File 'lib/cloudmersive-convert-api-client/models/docx_set_header_request.rb', line 186

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



192
193
194
195
196
197
198
199
200
 
# File 'lib/cloudmersive-convert-api-client/models/docx_set_header_request.rb', line 192

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



180
181
182
 
# File 'lib/cloudmersive-convert-api-client/models/docx_set_header_request.rb', line 180

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



79
80
81
82
 
# File 'lib/cloudmersive-convert-api-client/models/docx_set_header_request.rb', line 79

def valid?
  return false if !@input_file_bytes.nil? && @input_file_bytes !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
  true
end