Class: GroupDocsSignatureCloud::PagesSetup

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_signature_cloud/models/pages_setup.rb

Overview

Describes special pages of document to process

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PagesSetup

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/groupdocs_signature_cloud/models/pages_setup.rb', line 73

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

  if attributes.key?(:'LastPage')
    self.last_page = attributes[:'LastPage']
  end

  if attributes.key?(:'OddPages')
    self.odd_pages = attributes[:'OddPages']
  end

  if attributes.key?(:'EvenPages')
    self.even_pages = attributes[:'EvenPages']
  end

  if attributes.key?(:'PageNumbers')
    if (value = attributes[:'PageNumbers']).is_a?(Array)
      self.page_numbers = value
    end
  end

end

Instance Attribute Details

#even_pages ⇒ Object

Get or set flag to use even pages of document



44
45
46
 
# File 'lib/groupdocs_signature_cloud/models/pages_setup.rb', line 44

def even_pages
  @even_pages
end

#first_page ⇒ Object

Get or set flag to use first document page



35
36
37
 
# File 'lib/groupdocs_signature_cloud/models/pages_setup.rb', line 35

def first_page
  @first_page
end

#last_page ⇒ Object

Get or set flag to use last document page



38
39
40
 
# File 'lib/groupdocs_signature_cloud/models/pages_setup.rb', line 38

def last_page
  @last_page
end

#odd_pages ⇒ Object

Get or set flag to use odd pages of document



41
42
43
 
# File 'lib/groupdocs_signature_cloud/models/pages_setup.rb', line 41

def odd_pages
  @odd_pages
end

#page_numbers ⇒ Object

Set arbitrary pages of document to use



47
48
49
 
# File 'lib/groupdocs_signature_cloud/models/pages_setup.rb', line 47

def page_numbers
  @page_numbers
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
 
# File 'lib/groupdocs_signature_cloud/models/pages_setup.rb', line 50

def self.attribute_map
  {
    :'first_page' => :'FirstPage',
    :'last_page' => :'LastPage',
    :'odd_pages' => :'OddPages',
    :'even_pages' => :'EvenPages',
    :'page_numbers' => :'PageNumbers'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
 
# File 'lib/groupdocs_signature_cloud/models/pages_setup.rb', line 61

def self.swagger_types
  {
    :'first_page' => :'BOOLEAN',
    :'last_page' => :'BOOLEAN',
    :'odd_pages' => :'BOOLEAN',
    :'even_pages' => :'BOOLEAN',
    :'page_numbers' => :'Array<Integer>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



138
139
140
141
142
143
144
145
146
 
# File 'lib/groupdocs_signature_cloud/models/pages_setup.rb', line 138

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      first_page == other.first_page &&
      last_page == other.last_page &&
      odd_pages == other.odd_pages &&
      even_pages == other.even_pages &&
      page_numbers == other.page_numbers
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



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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/groupdocs_signature_cloud/models/pages_setup.rb', line 193

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Date.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
    # Signature type fix
    ttype = type
    if value.is_a?(Hash) and !value[:signatureType].nil?
      ttype = value[:signatureType] + 'Signature'
      if value[:signatureType] == 'FormField' and !value[:type].nil?
        type = value[:type]
        if type == 'Checkbox'
          ttype = 'CheckboxFormFieldSignature'
        end
        if type == 'Text'
          ttype = 'TextFormFieldSignature'
        end
        if type == 'Combobox'
          ttype = 'ComboboxFormFieldSignature'
        end
        if type == 'DigitalSignature'
          ttype = 'DigitalFormFieldSignature'
        end
        if type == 'Radio'
          ttype = 'RadioButtonFormFieldSignature'
        end
      end
    end      
    temp_model = GroupDocsSignatureCloud.const_get(ttype).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



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/groupdocs_signature_cloud/models/pages_setup.rb', line 283

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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/groupdocs_signature_cloud/models/pages_setup.rb', line 169

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    pname = uncap(self.class.attribute_map[key]).intern
    value = attributes[pname]
    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 value.is_a?(Array)
        self.send("#{key}=", value.map { |v| _deserialize($1, v) })
      end
    elsif !value.nil?                  
      self.send("#{key}=", _deserialize(type, value))
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


150
151
152
 
# File 'lib/groupdocs_signature_cloud/models/pages_setup.rb', line 150

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



156
157
158
 
# File 'lib/groupdocs_signature_cloud/models/pages_setup.rb', line 156

def hash
  [first_page, last_page, odd_pages, even_pages, page_numbers].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/groupdocs_signature_cloud/models/pages_setup.rb', line 105

def list_invalid_properties
  invalid_properties = []
  if @first_page.nil?
    invalid_properties.push("invalid value for 'first_page', first_page cannot be nil.")
  end

  if @last_page.nil?
    invalid_properties.push("invalid value for 'last_page', last_page cannot be nil.")
  end

  if @odd_pages.nil?
    invalid_properties.push("invalid value for 'odd_pages', odd_pages cannot be nil.")
  end

  if @even_pages.nil?
    invalid_properties.push("invalid value for 'even_pages', even_pages cannot be nil.")
  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



263
264
265
 
# File 'lib/groupdocs_signature_cloud/models/pages_setup.rb', line 263

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



269
270
271
272
273
274
275
276
277
 
# File 'lib/groupdocs_signature_cloud/models/pages_setup.rb', line 269

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



257
258
259
 
# File 'lib/groupdocs_signature_cloud/models/pages_setup.rb', line 257

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



162
163
164
 
# File 'lib/groupdocs_signature_cloud/models/pages_setup.rb', line 162

def uncap(str)
  str[0, 1].downcase + str[1..-1]
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



128
129
130
131
132
133
134
 
# File 'lib/groupdocs_signature_cloud/models/pages_setup.rb', line 128

def valid?
  return false if @first_page.nil?
  return false if @last_page.nil?
  return false if @odd_pages.nil?
  return false if @even_pages.nil?
  return true
end