Class: FactPulse::ReponseSoumissionFlux

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

Overview

Réponse après soumission d’un flux

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/factpulse/models/reponse_soumission_flux.rb', line 84

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

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

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

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

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

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

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

Instance Attribute Details

#flow_id ⇒ Object

Identifiant unique du flux généré par la PDP



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

def flow_id
  @flow_id
end

#message ⇒ Object

Message de confirmation



36
37
38
 
# File 'lib/factpulse/models/reponse_soumission_flux.rb', line 36

def message
  @message
end

#nom ⇒ Object

Nom du flux



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

def nom
  @nom
end

#profil_flux ⇒ Object

Returns the value of attribute profil_flux.



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

def profil_flux
  @profil_flux
end

#sha256 ⇒ Object

Hash SHA256 du fichier soumis



33
34
35
 
# File 'lib/factpulse/models/reponse_soumission_flux.rb', line 33

def sha256
  @sha256
end

#syntaxe_flux ⇒ Object

Syntaxe du flux (CII, UBL, etc.)



28
29
30
 
# File 'lib/factpulse/models/reponse_soumission_flux.rb', line 28

def syntaxe_flux
  @syntaxe_flux
end

#tracking_id ⇒ Object

Returns the value of attribute tracking_id.



22
23
24
 
# File 'lib/factpulse/models/reponse_soumission_flux.rb', line 22

def tracking_id
  @tracking_id
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



52
53
54
 
# File 'lib/factpulse/models/reponse_soumission_flux.rb', line 52

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



57
58
59
 
# File 'lib/factpulse/models/reponse_soumission_flux.rb', line 57

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/factpulse/models/reponse_soumission_flux.rb', line 39

def self.attribute_map
  {
    :'flow_id' => :'flow_id',
    :'tracking_id' => :'tracking_id',
    :'nom' => :'nom',
    :'syntaxe_flux' => :'syntaxe_flux',
    :'profil_flux' => :'profil_flux',
    :'sha256' => :'sha256',
    :'message' => :'message'
  }
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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/factpulse/models/reponse_soumission_flux.rb', line 256

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/factpulse/models/reponse_soumission_flux.rb', line 62

def self.openapi_types
  {
    :'flow_id' => :'String',
    :'tracking_id' => :'String',
    :'nom' => :'String',
    :'syntaxe_flux' => :'String',
    :'profil_flux' => :'String',
    :'sha256' => :'String',
    :'message' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/factpulse/models/reponse_soumission_flux.rb', line 229

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      flow_id == o.flow_id &&
      tracking_id == o.tracking_id &&
      nom == o.nom &&
      syntaxe_flux == o.syntaxe_flux &&
      profil_flux == o.profil_flux &&
      sha256 == o.sha256 &&
      message == o.message
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


243
244
245
 
# File 'lib/factpulse/models/reponse_soumission_flux.rb', line 243

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



249
250
251
 
# File 'lib/factpulse/models/reponse_soumission_flux.rb', line 249

def hash
  [flow_id, tracking_id, nom, syntaxe_flux, profil_flux, sha256, message].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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/factpulse/models/reponse_soumission_flux.rb', line 139

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

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

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

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

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



278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/factpulse/models/reponse_soumission_flux.rb', line 278

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



167
168
169
170
171
172
173
174
175
 
# File 'lib/factpulse/models/reponse_soumission_flux.rb', line 167

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @flow_id.nil?
  return false if @nom.nil?
  return false if @syntaxe_flux.nil?
  return false if @sha256.nil?
  return false if @message.nil?
  true
end