Class: FactPulse::ProcessingOptions

Inherits:
ApiModelBase show all
Defined in:
lib/factpulse/models/processing_options.rb

Overview

Processing options for generation and submission.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ ProcessingOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/factpulse/models/processing_options.rb', line 91

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

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

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

  if attributes.key?(:'auto_enrich')
    self.auto_enrich = attributes[:'auto_enrich']
  else
    self.auto_enrich = true
  end

  if attributes.key?(:'validate')
    self.validate = attributes[:'validate']
  else
    self.validate = true
  end

  if attributes.key?(:'verify_destination_parameters')
    self.verify_destination_parameters = attributes[:'verify_destination_parameters']
  else
    self.verify_destination_parameters = true
  end
end

Instance Attribute Details

#auto_enrich ⇒ Object

Auto-enrich data (Company APIs, Chorus Pro, etc.)



23
24
25
 
# File 'lib/factpulse/models/processing_options.rb', line 23

def auto_enrich
  @auto_enrich
end

#facturx_profile ⇒ Object

Factur-X profile to use



20
21
22
 
# File 'lib/factpulse/models/processing_options.rb', line 20

def facturx_profile
  @facturx_profile
end

#validate ⇒ Object

Validate Factur-X XML with Schematron



26
27
28
 
# File 'lib/factpulse/models/processing_options.rb', line 26

def validate
  @validate
end

#verify_destination_parameters ⇒ Object

Verify required parameters for destination (e.g., service_code for Chorus)



29
30
31
 
# File 'lib/factpulse/models/processing_options.rb', line 29

def verify_destination_parameters
  @verify_destination_parameters
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



64
65
66
 
# File 'lib/factpulse/models/processing_options.rb', line 64

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



69
70
71
 
# File 'lib/factpulse/models/processing_options.rb', line 69

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
 
# File 'lib/factpulse/models/processing_options.rb', line 54

def self.attribute_map
  {
    :'facturx_profile' => :'facturxProfile',
    :'auto_enrich' => :'autoEnrich',
    :'validate' => :'validate',
    :'verify_destination_parameters' => :'verifyDestinationParameters'
  }
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/factpulse/models/processing_options.rb', line 169

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



84
85
86
87
 
# File 'lib/factpulse/models/processing_options.rb', line 84

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
 
# File 'lib/factpulse/models/processing_options.rb', line 74

def self.openapi_types
  {
    :'facturx_profile' => :'APIProfile',
    :'auto_enrich' => :'Boolean',
    :'validate' => :'Boolean',
    :'verify_destination_parameters' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



145
146
147
148
149
150
151
152
 
# File 'lib/factpulse/models/processing_options.rb', line 145

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      facturx_profile == o.facturx_profile &&
      auto_enrich == o.auto_enrich &&
      validate == o.validate &&
      verify_destination_parameters == o.verify_destination_parameters
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


156
157
158
 
# File 'lib/factpulse/models/processing_options.rb', line 156

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



162
163
164
 
# File 'lib/factpulse/models/processing_options.rb', line 162

def hash
  [facturx_profile, auto_enrich, validate, verify_destination_parameters].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



130
131
132
133
134
 
# File 'lib/factpulse/models/processing_options.rb', line 130

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/factpulse/models/processing_options.rb', line 191

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



138
139
140
141
 
# File 'lib/factpulse/models/processing_options.rb', line 138

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