Class: FactPulse::SoumettreFactureCompleteRequest

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/factpulse/models/soumettre_facture_complete_request.rb

Overview

Requête pour soumettre une facture complète (génération + soumission). Workflow : 1. Auto-enrichissement (optionnel) 2. Génération PDF Factur-X 3. Signature (optionnelle) 4. Soumission vers la destination

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 = {}) ⇒ SoumettreFactureCompleteRequest

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
108
109
110
111
112
 
# File 'lib/factpulse/models/soumettre_facture_complete_request.rb', line 73

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FactPulse::SoumettreFactureCompleteRequest` 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::SoumettreFactureCompleteRequest`. 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?(:'donnees_facture')
    self.donnees_facture = attributes[:'donnees_facture']
  else
    self.donnees_facture = nil
  end

  if attributes.key?(:'pdf_source')
    self.pdf_source = attributes[:'pdf_source']
  else
    self.pdf_source = nil
  end

  if attributes.key?(:'destination')
    self.destination = attributes[:'destination']
  else
    self.destination = nil
  end

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

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

Instance Attribute Details

#destination ⇒ Object

Returns the value of attribute destination.



25
26
27
 
# File 'lib/factpulse/models/soumettre_facture_complete_request.rb', line 25

def destination
  @destination
end

#donnees_facture ⇒ Object

Données de la facture au format simplifié (voir exemples)



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

def donnees_facture
  @donnees_facture
end

#options ⇒ Object

Options de traitement



30
31
32
 
# File 'lib/factpulse/models/soumettre_facture_complete_request.rb', line 30

def options
  @options
end

#pdf_source ⇒ Object

PDF source encodé en base64 (sera transformé en Factur-X)



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

def pdf_source
  @pdf_source
end

#signature ⇒ Object

Returns the value of attribute signature.



27
28
29
 
# File 'lib/factpulse/models/soumettre_facture_complete_request.rb', line 27

def signature
  @signature
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



44
45
46
 
# File 'lib/factpulse/models/soumettre_facture_complete_request.rb', line 44

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



49
50
51
 
# File 'lib/factpulse/models/soumettre_facture_complete_request.rb', line 49

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/factpulse/models/soumettre_facture_complete_request.rb', line 33

def self.attribute_map
  {
    :'donnees_facture' => :'donnees_facture',
    :'pdf_source' => :'pdf_source',
    :'destination' => :'destination',
    :'signature' => :'signature',
    :'options' => :'options'
  }
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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/factpulse/models/soumettre_facture_complete_request.rb', line 201

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



65
66
67
68
69
 
# File 'lib/factpulse/models/soumettre_facture_complete_request.rb', line 65

def self.openapi_nullable
  Set.new([
    :'signature',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'donnees_facture' => :'DonneesFactureSimplifiees',
    :'pdf_source' => :'String',
    :'destination' => :'Destination',
    :'signature' => :'ParametresSignature',
    :'options' => :'OptionsProcessing'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



176
177
178
179
180
181
182
183
184
 
# File 'lib/factpulse/models/soumettre_facture_complete_request.rb', line 176

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      donnees_facture == o.donnees_facture &&
      pdf_source == o.pdf_source &&
      destination == o.destination &&
      signature == o.signature &&
      options == o.options
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


188
189
190
 
# File 'lib/factpulse/models/soumettre_facture_complete_request.rb', line 188

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



194
195
196
 
# File 'lib/factpulse/models/soumettre_facture_complete_request.rb', line 194

def hash
  [donnees_facture, pdf_source, destination, signature, options].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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/factpulse/models/soumettre_facture_complete_request.rb', line 116

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @donnees_facture.nil?
    invalid_properties.push('invalid value for "donnees_facture", donnees_facture cannot be nil.')
  end

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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/factpulse/models/soumettre_facture_complete_request.rb', line 223

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



136
137
138
139
140
141
142
 
# File 'lib/factpulse/models/soumettre_facture_complete_request.rb', line 136

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @donnees_facture.nil?
  return false if @pdf_source.nil?
  return false if @destination.nil?
  true
end