Class: FactPulse::RequeteRechercheFlux

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

Overview

Requête pour rechercher des flux soumis

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/factpulse/models/requete_recherche_flux.rb', line 116

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

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

  if attributes.key?(:'type_flux')
    if (value = attributes[:'type_flux']).is_a?(Array)
      self.type_flux = value
    end
  end

  if attributes.key?(:'direction_flux')
    if (value = attributes[:'direction_flux']).is_a?(Array)
      self.direction_flux = value
    end
  end

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

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

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

  if attributes.key?(:'offset')
    self.offset = attributes[:'offset']
  else
    self.offset = 0
  end

  if attributes.key?(:'limit')
    self.limit = attributes[:'limit']
  else
    self.limit = 25
  end
end

Instance Attribute Details

#date_maj_apres ⇒ Object

Returns the value of attribute date_maj_apres.



19
20
21
 
# File 'lib/factpulse/models/requete_recherche_flux.rb', line 19

def date_maj_apres
  @date_maj_apres
end

#date_maj_avant ⇒ Object

Returns the value of attribute date_maj_avant.



21
22
23
 
# File 'lib/factpulse/models/requete_recherche_flux.rb', line 21

def date_maj_avant
  @date_maj_avant
end

#direction_flux ⇒ Object

Returns the value of attribute direction_flux.



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

def direction_flux
  @direction_flux
end

#flow_id ⇒ Object

Returns the value of attribute flow_id.



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

def flow_id
  @flow_id
end

#limit ⇒ Object

Nombre maximum de résultats (max 100)



37
38
39
 
# File 'lib/factpulse/models/requete_recherche_flux.rb', line 37

def limit
  @limit
end

#offset ⇒ Object

Décalage pour la pagination



34
35
36
 
# File 'lib/factpulse/models/requete_recherche_flux.rb', line 34

def offset
  @offset
end

#statut_acquittement ⇒ Object

Returns the value of attribute statut_acquittement.



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

def statut_acquittement
  @statut_acquittement
end

#tracking_id ⇒ Object

Returns the value of attribute tracking_id.



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

def tracking_id
  @tracking_id
end

#type_flux ⇒ Object

Returns the value of attribute type_flux.



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

def type_flux
  @type_flux
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



77
78
79
 
# File 'lib/factpulse/models/requete_recherche_flux.rb', line 77

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



82
83
84
 
# File 'lib/factpulse/models/requete_recherche_flux.rb', line 82

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'date_maj_apres' => :'date_maj_apres',
    :'date_maj_avant' => :'date_maj_avant',
    :'type_flux' => :'type_flux',
    :'direction_flux' => :'direction_flux',
    :'tracking_id' => :'tracking_id',
    :'flow_id' => :'flow_id',
    :'statut_acquittement' => :'statut_acquittement',
    :'offset' => :'offset',
    :'limit' => :'limit'
  }
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



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/factpulse/models/requete_recherche_flux.rb', line 268

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



102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/factpulse/models/requete_recherche_flux.rb', line 102

def self.openapi_nullable
  Set.new([
    :'date_maj_apres',
    :'date_maj_avant',
    :'type_flux',
    :'direction_flux',
    :'tracking_id',
    :'flow_id',
    :'statut_acquittement',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/factpulse/models/requete_recherche_flux.rb', line 87

def self.openapi_types
  {
    :'date_maj_apres' => :'Time',
    :'date_maj_avant' => :'Time',
    :'type_flux' => :'Array<TypeFlux>',
    :'direction_flux' => :'Array<DirectionFlux>',
    :'tracking_id' => :'String',
    :'flow_id' => :'String',
    :'statut_acquittement' => :'StatutAcquittement',
    :'offset' => :'Integer',
    :'limit' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/factpulse/models/requete_recherche_flux.rb', line 239

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      date_maj_apres == o.date_maj_apres &&
      date_maj_avant == o.date_maj_avant &&
      type_flux == o.type_flux &&
      direction_flux == o.direction_flux &&
      tracking_id == o.tracking_id &&
      flow_id == o.flow_id &&
      statut_acquittement == o.statut_acquittement &&
      offset == o.offset &&
      limit == o.limit
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


255
256
257
 
# File 'lib/factpulse/models/requete_recherche_flux.rb', line 255

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



261
262
263
 
# File 'lib/factpulse/models/requete_recherche_flux.rb', line 261

def hash
  [date_maj_apres, date_maj_avant, type_flux, direction_flux, tracking_id, flow_id, statut_acquittement, offset, limit].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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/factpulse/models/requete_recherche_flux.rb', line 177

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@offset.nil? && @offset < 0
    invalid_properties.push('invalid value for "offset", must be greater than or equal to 0.')
  end

  if !@limit.nil? && @limit > 100
    invalid_properties.push('invalid value for "limit", must be smaller than or equal to 100.')
  end

  if !@limit.nil? && @limit < 1
    invalid_properties.push('invalid value for "limit", must be greater than or equal to 1.')
  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



290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/factpulse/models/requete_recherche_flux.rb', line 290

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



197
198
199
200
201
202
203
 
# File 'lib/factpulse/models/requete_recherche_flux.rb', line 197

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@offset.nil? && @offset < 0
  return false if !@limit.nil? && @limit > 100
  return false if !@limit.nil? && @limit < 1
  true
end