Class: FactPulse::StructureInfo

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

Overview

Informations d’une structure.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
113
114
115
116
117
 
# File 'lib/factpulse/models/structure_info.rb', line 74

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

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

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

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

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

Instance Attribute Details

#designation_structure ⇒ Object

Nom de la structure



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

def designation_structure
  @designation_structure
end

#id_structure_cpp ⇒ Object

ID Chorus Pro de la structure



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

def id_structure_cpp
  @id_structure_cpp
end

#identifiant_structure ⇒ Object

Identifiant (SIRET, SIREN)



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

def identifiant_structure
  @identifiant_structure
end

#statut ⇒ Object

Statut (ACTIVE, INACTIVE)



32
33
34
 
# File 'lib/factpulse/models/structure_info.rb', line 32

def statut
  @statut
end

#type_identifiant_structure ⇒ Object

Type d’identifiant



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

def type_identifiant_structure
  @type_identifiant_structure
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



46
47
48
 
# File 'lib/factpulse/models/structure_info.rb', line 46

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



51
52
53
 
# File 'lib/factpulse/models/structure_info.rb', line 51

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
 
# File 'lib/factpulse/models/structure_info.rb', line 35

def self.attribute_map
  {
    :'id_structure_cpp' => :'id_structure_cpp',
    :'identifiant_structure' => :'identifiant_structure',
    :'designation_structure' => :'designation_structure',
    :'type_identifiant_structure' => :'type_identifiant_structure',
    :'statut' => :'statut'
  }
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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/factpulse/models/structure_info.rb', line 236

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id_structure_cpp' => :'Integer',
    :'identifiant_structure' => :'String',
    :'designation_structure' => :'String',
    :'type_identifiant_structure' => :'String',
    :'statut' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



211
212
213
214
215
216
217
218
219
 
# File 'lib/factpulse/models/structure_info.rb', line 211

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id_structure_cpp == o.id_structure_cpp &&
      identifiant_structure == o.identifiant_structure &&
      designation_structure == o.designation_structure &&
      type_identifiant_structure == o.type_identifiant_structure &&
      statut == o.statut
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


223
224
225
 
# File 'lib/factpulse/models/structure_info.rb', line 223

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



229
230
231
 
# File 'lib/factpulse/models/structure_info.rb', line 229

def hash
  [id_structure_cpp, identifiant_structure, designation_structure, type_identifiant_structure, statut].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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/factpulse/models/structure_info.rb', line 121

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

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

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

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

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



258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/factpulse/models/structure_info.rb', line 258

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



149
150
151
152
153
154
155
156
157
 
# File 'lib/factpulse/models/structure_info.rb', line 149

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id_structure_cpp.nil?
  return false if @identifiant_structure.nil?
  return false if @designation_structure.nil?
  return false if @type_identifiant_structure.nil?
  return false if @statut.nil?
  true
end