Class: FattureInCloud_Ruby_Sdk::IssuedDocumentOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/fattureincloud_ruby_sdk/models/issued_document_options.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IssuedDocumentOptions

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
102
103
104
105
106
107
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_options.rb', line 73

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FattureInCloud_Ruby_Sdk::IssuedDocumentOptions` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `FattureInCloud_Ruby_Sdk::IssuedDocumentOptions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

Instance Attribute Details

#create_from ⇒ Object

Original documents ids [only for join/transform]



22
23
24
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_options.rb', line 22

def create_from
  @create_from
end

#fix_payments ⇒ Object

Fixes your last payment amount to match your document total



19
20
21
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_options.rb', line 19

def fix_payments
  @fix_payments
end

#join_type ⇒ Object

Join type [only for join]



31
32
33
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_options.rb', line 31

def join_type
  @join_type
end

#keep_copy ⇒ Object

Keep original document [only for transform]



28
29
30
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_options.rb', line 28

def keep_copy
  @keep_copy
end

#transform ⇒ Object

Tranform a document [only for transform]



25
26
27
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_options.rb', line 25

def transform
  @transform
end

Class Method Details

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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_options.rb', line 175

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
  when :Hash
    value
  else # model
    # models (e.g. Pet) or oneOf
    klass = FattureInCloud_Ruby_Sdk.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



45
46
47
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_options.rb', line 45

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_options.rb', line 34

def self.attribute_map
  {
    :'fix_payments' => :'fix_payments',
    :'create_from' => :'create_from',
    :'transform' => :'transform',
    :'keep_copy' => :'keep_copy',
    :'join_type' => :'join_type'
  }
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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_options.rb', line 151

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

def self.openapi_nullable
  Set.new([
    :'fix_payments',
    :'create_from',
    :'transform',
    :'keep_copy',
    :'join_type'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'fix_payments' => :'Boolean',
    :'create_from' => :'Array<String>',
    :'transform' => :'Boolean',
    :'keep_copy' => :'Boolean',
    :'join_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



126
127
128
129
130
131
132
133
134
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_options.rb', line 126

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      fix_payments == o.fix_payments &&
      create_from == o.create_from &&
      transform == o.transform &&
      keep_copy == o.keep_copy &&
      join_type == o.join_type
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



248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_options.rb', line 248

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


138
139
140
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_options.rb', line 138

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



144
145
146
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_options.rb', line 144

def hash
  [fix_payments, create_from, transform, keep_copy, join_type].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



111
112
113
114
115
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_options.rb', line 111

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



224
225
226
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_options.rb', line 224

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



230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_options.rb', line 230

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



218
219
220
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_options.rb', line 218

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



119
120
121
122
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_options.rb', line 119

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end