Class: FactPulse::RequeteSoumissionFlux

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

Overview

Requête pour soumettre une facture à une PDP/PA via AFNOR

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/factpulse/models/requete_soumission_flux.rb', line 101

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

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

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

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

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

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

Instance Attribute Details

#nom_flux ⇒ Object

Nom du flux (ex: ‘Facture 2025-001’)



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

def nom_flux
  @nom_flux
end

#pdp_credentials ⇒ Object

Returns the value of attribute pdp_credentials.



31
32
33
 
# File 'lib/factpulse/models/requete_soumission_flux.rb', line 31

def pdp_credentials
  @pdp_credentials
end

#profil_flux ⇒ Object

Returns the value of attribute profil_flux.



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

def profil_flux
  @profil_flux
end

#request_id ⇒ Object

Returns the value of attribute request_id.



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

def request_id
  @request_id
end

#syntaxe_flux ⇒ Object

Syntaxe du flux (CII pour Factur-X)



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

def syntaxe_flux
  @syntaxe_flux
end

#tracking_id ⇒ Object

Returns the value of attribute tracking_id.



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

def tracking_id
  @tracking_id
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



68
69
70
 
# File 'lib/factpulse/models/requete_soumission_flux.rb', line 68

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



73
74
75
 
# File 'lib/factpulse/models/requete_soumission_flux.rb', line 73

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
 
# File 'lib/factpulse/models/requete_soumission_flux.rb', line 56

def self.attribute_map
  {
    :'nom_flux' => :'nom_flux',
    :'syntaxe_flux' => :'syntaxe_flux',
    :'profil_flux' => :'profil_flux',
    :'tracking_id' => :'tracking_id',
    :'request_id' => :'request_id',
    :'pdp_credentials' => :'pdp_credentials'
  }
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



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

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



90
91
92
93
94
95
96
97
 
# File 'lib/factpulse/models/requete_soumission_flux.rb', line 90

def self.openapi_nullable
  Set.new([
    :'profil_flux',
    :'tracking_id',
    :'request_id',
    :'pdp_credentials'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
 
# File 'lib/factpulse/models/requete_soumission_flux.rb', line 78

def self.openapi_types
  {
    :'nom_flux' => :'String',
    :'syntaxe_flux' => :'SyntaxeFlux',
    :'profil_flux' => :'ProfilFlux',
    :'tracking_id' => :'String',
    :'request_id' => :'String',
    :'pdp_credentials' => :'PDPCredentials'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



174
175
176
177
178
179
180
181
182
183
 
# File 'lib/factpulse/models/requete_soumission_flux.rb', line 174

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      nom_flux == o.nom_flux &&
      syntaxe_flux == o.syntaxe_flux &&
      profil_flux == o.profil_flux &&
      tracking_id == o.tracking_id &&
      request_id == o.request_id &&
      pdp_credentials == o.pdp_credentials
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


187
188
189
 
# File 'lib/factpulse/models/requete_soumission_flux.rb', line 187

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



193
194
195
 
# File 'lib/factpulse/models/requete_soumission_flux.rb', line 193

def hash
  [nom_flux, syntaxe_flux, profil_flux, tracking_id, request_id, pdp_credentials].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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @nom_flux.nil?
    invalid_properties.push('invalid value for "nom_flux", nom_flux 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



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

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



156
157
158
159
160
 
# File 'lib/factpulse/models/requete_soumission_flux.rb', line 156

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