Class: Repull::AirbnbDataFreshness

Inherits:
ApiModelBase show all
Defined in:
lib/repull/models/airbnb_data_freshness.rb

Overview

Top-level freshness indicator for any DB-backed Airbnb read. Tells consumers WHY a column may be ‘null` or stale without sprinkling per-row error envelopes through the response. The endpoint always returns 200 + DB data; this field is the single signal for "should I prompt the user to reconnect / wait for sync?".

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



72
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
 
# File 'lib/repull/models/airbnb_data_freshness.rb', line 72

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

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

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

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

Instance Attribute Details

#fix_url ⇒ Object

Dashboard URL the consumer can open to resolve the staleness (typically the Airbnb reconnect screen). Omitted when ‘stale` is `false`.



29
30
31
 
# File 'lib/repull/models/airbnb_data_freshness.rb', line 29

def fix_url
  @fix_url
end

#last_synced_at ⇒ Object

Most recent sync timestamp across the rows in the response. ‘null` when nothing has ever synced for this customer.



20
21
22
 
# File 'lib/repull/models/airbnb_data_freshness.rb', line 20

def last_synced_at
  @last_synced_at
end

#reason ⇒ Object

Why the data is stale. One of ‘host_disconnected_since_<iso>`, `sync_lag_>_24h`, `never_synced`. Omitted when `stale` is `false`.



26
27
28
 
# File 'lib/repull/models/airbnb_data_freshness.rb', line 26

def reason
  @reason
end

#stale ⇒ Object

‘true` when any host is disconnected, when the local cache is empty, or when the cache hasn’t been refreshed in 24h+. ‘false` when hosts are healthy and sync is fresh.



23
24
25
 
# File 'lib/repull/models/airbnb_data_freshness.rb', line 23

def stale
  @stale
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



42
43
44
 
# File 'lib/repull/models/airbnb_data_freshness.rb', line 42

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



47
48
49
 
# File 'lib/repull/models/airbnb_data_freshness.rb', line 47

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
 
# File 'lib/repull/models/airbnb_data_freshness.rb', line 32

def self.attribute_map
  {
    :'last_synced_at' => :'last_synced_at',
    :'stale' => :'stale',
    :'reason' => :'reason',
    :'fix_url' => :'fix_url'
  }
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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/repull/models/airbnb_data_freshness.rb', line 163

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



62
63
64
65
66
67
68
 
# File 'lib/repull/models/airbnb_data_freshness.rb', line 62

def self.openapi_nullable
  Set.new([
    :'last_synced_at',
    :'reason',
    :'fix_url'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
 
# File 'lib/repull/models/airbnb_data_freshness.rb', line 52

def self.openapi_types
  {
    :'last_synced_at' => :'Time',
    :'stale' => :'Boolean',
    :'reason' => :'String',
    :'fix_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



139
140
141
142
143
144
145
146
 
# File 'lib/repull/models/airbnb_data_freshness.rb', line 139

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      last_synced_at == o.last_synced_at &&
      stale == o.stale &&
      reason == o.reason &&
      fix_url == o.fix_url
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


150
151
152
 
# File 'lib/repull/models/airbnb_data_freshness.rb', line 150

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



156
157
158
 
# File 'lib/repull/models/airbnb_data_freshness.rb', line 156

def hash
  [last_synced_at, stale, reason, fix_url].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



109
110
111
112
113
114
115
116
117
 
# File 'lib/repull/models/airbnb_data_freshness.rb', line 109

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



185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/repull/models/airbnb_data_freshness.rb', line 185

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



121
122
123
124
125
 
# File 'lib/repull/models/airbnb_data_freshness.rb', line 121

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