Class: CloudmersiveConvertApiClient::DocxInsertImageRequest

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

Overview

Input to set-footer command

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocxInsertImageRequest

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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/cloudmersive-convert-api-client/models/docx_insert_image_request.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?(:'InputDocumentFileBytes')
    self.input_document_file_bytes = attributes[:'InputDocumentFileBytes']
  end

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

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

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

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

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

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

end

Instance Attribute Details

#image_to_add ⇒ Object

Optional: Image to add; if you supply in this object, do not supply InputImageFileBytes or InputImageFileUrl.



31
32
33
 
# File 'lib/cloudmersive-convert-api-client/models/docx_insert_image_request.rb', line 31

def image_to_add
  @image_to_add
end

#input_document_file_bytes ⇒ Object

Optional: Bytes of the input file to operate on



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

def input_document_file_bytes
  @input_document_file_bytes
end

#input_document_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_insert_image_request.rb', line 22

def input_document_file_url
  @input_document_file_url
end

#input_image_file_bytes ⇒ Object

Optional: Bytes of the input image file to operate on; if you supply this value do not supply InputImageFileUrl or ImageToAdd.



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

def input_image_file_bytes
  @input_image_file_bytes
end

#input_image_file_url ⇒ Object

Optional: URL of an image file to operate on as input; if you supply this value do not supply InputImageFileBytes or ImageToAdd. 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).



28
29
30
 
# File 'lib/cloudmersive-convert-api-client/models/docx_insert_image_request.rb', line 28

def input_image_file_url
  @input_image_file_url
end

#insert_path ⇒ Object

Optional; location within the document to insert the object; fill in the InsertPath field using the Path value from an existing object. Used with InsertPlacement of BeforeExistingObject or AfterExistingObject



37
38
39
 
# File 'lib/cloudmersive-convert-api-client/models/docx_insert_image_request.rb', line 37

def insert_path
  @insert_path
end

#insert_placement ⇒ Object

Optional; default is DocumentEnd. Placement Type of the insert; possible values are: DocumentStart (very beginning of the document), DocumentEnd (very end of the document), BeforeExistingObject (right before an existing object - fill in the InsertPath field using the Path value from an existing object), AfterExistingObject (right after an existing object - fill in the InsertPath field using the Path value from an existing object)



34
35
36
 
# File 'lib/cloudmersive-convert-api-client/models/docx_insert_image_request.rb', line 34

def insert_placement
  @insert_placement
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/cloudmersive-convert-api-client/models/docx_insert_image_request.rb', line 41

def self.attribute_map
  {
    :'input_document_file_bytes' => :'InputDocumentFileBytes',
    :'input_document_file_url' => :'InputDocumentFileUrl',
    :'input_image_file_bytes' => :'InputImageFileBytes',
    :'input_image_file_url' => :'InputImageFileUrl',
    :'image_to_add' => :'ImageToAdd',
    :'insert_placement' => :'InsertPlacement',
    :'insert_path' => :'InsertPath'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/cloudmersive-convert-api-client/models/docx_insert_image_request.rb', line 54

def self.swagger_types
  {
    :'input_document_file_bytes' => :'String',
    :'input_document_file_url' => :'String',
    :'input_image_file_bytes' => :'String',
    :'input_image_file_url' => :'String',
    :'image_to_add' => :'DocxImage',
    :'insert_placement' => :'String',
    :'insert_path' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/cloudmersive-convert-api-client/models/docx_insert_image_request.rb', line 151

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      input_document_file_bytes == o.input_document_file_bytes &&
      input_document_file_url == o.input_document_file_url &&
      input_image_file_bytes == o.input_image_file_bytes &&
      input_image_file_url == o.input_image_file_url &&
      image_to_add == o.image_to_add &&
      insert_placement == o.insert_placement &&
      insert_path == o.insert_path
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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/cloudmersive-convert-api-client/models/docx_insert_image_request.rb', line 199

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



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/cloudmersive-convert-api-client/models/docx_insert_image_request.rb', line 265

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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/cloudmersive-convert-api-client/models/docx_insert_image_request.rb', line 178

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 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


165
166
167
 
# File 'lib/cloudmersive-convert-api-client/models/docx_insert_image_request.rb', line 165

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



171
172
173
 
# File 'lib/cloudmersive-convert-api-client/models/docx_insert_image_request.rb', line 171

def hash
  [input_document_file_bytes, input_document_file_url, input_image_file_bytes, input_image_file_url, image_to_add, insert_placement, insert_path].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



106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/cloudmersive-convert-api-client/models/docx_insert_image_request.rb', line 106

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

  if !@input_image_file_bytes.nil? && @input_image_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_image_file_bytes', must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/.")
  end

  return 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



245
246
247
 
# File 'lib/cloudmersive-convert-api-client/models/docx_insert_image_request.rb', line 245

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



251
252
253
254
255
256
257
258
259
 
# File 'lib/cloudmersive-convert-api-client/models/docx_insert_image_request.rb', line 251

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



239
240
241
 
# File 'lib/cloudmersive-convert-api-client/models/docx_insert_image_request.rb', line 239

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



121
122
123
124
125
 
# File 'lib/cloudmersive-convert-api-client/models/docx_insert_image_request.rb', line 121

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