Class: Weft::SearchEndpointPrice

Inherits:
ApiModelBase show all
Defined in:
lib/weft/generated/models/search_endpoint_price.rb

Overview

Price + provenance + freshness for this (endpoint × capability) pairing. Always present; an unpriced endpoint carries null amounts rather than an absent block, so a caller never has to distinguish "free" from "we do not know".

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/weft/generated/models/search_endpoint_price.rb', line 96

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

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

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

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

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

Instance Attribute Details

#atomic ⇒ Object

The same price in integer micro-USD — the settlement grain, exact. Null exactly when indexed_usd is. Use this for settlement.



23
24
25
 
# File 'lib/weft/generated/models/search_endpoint_price.rb', line 23

def atomic
  @atomic
end

#indexed_usd ⇒ Object

The indexed price in USD as a decimal string (e.g. "0.008") — the dollar value people and agents reason in. A decimal string, never a float; trailing zeros trimmed. Null when unpriced.



20
21
22
 
# File 'lib/weft/generated/models/search_endpoint_price.rb', line 20

def indexed_usd
  @indexed_usd
end

#last_observed_at ⇒ Object

When the amount was observed. Null when unrecorded.



29
30
31
 
# File 'lib/weft/generated/models/search_endpoint_price.rb', line 29

def last_observed_at
  @last_observed_at
end

#live_verified ⇒ Object

Whether this amount was confirmed against a live 402 challenge for THIS response. Search does not issue a payment-required probe at query time, so this is false today — treat an unflagged price as indexed, not verified.



32
33
34
 
# File 'lib/weft/generated/models/search_endpoint_price.rb', line 32

def live_verified
  @live_verified
end

#source ⇒ Object

Where the amount came from. probe = observed live in the endpoint's own 402 payment-required challenge — an observation, the strongest evidence we hold. inferred = derived from a spec (OpenAPI) or a resale edge by the extraction pipeline, so it can lag a provider's re-pricing. Null when the endpoint carries no price.



26
27
28
 
# File 'lib/weft/generated/models/search_endpoint_price.rb', line 26

def source
  @source
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



68
69
70
 
# File 'lib/weft/generated/models/search_endpoint_price.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/weft/generated/models/search_endpoint_price.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.



57
58
59
60
61
62
63
64
65
 
# File 'lib/weft/generated/models/search_endpoint_price.rb', line 57

def self.attribute_map
  {
    :'indexed_usd' => :'indexed_usd',
    :'atomic' => :'atomic',
    :'source' => :'source',
    :'last_observed_at' => :'last_observed_at',
    :'live_verified' => :'live_verified'
  }
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



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/weft/generated/models/search_endpoint_price.rb', line 185

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



89
90
91
92
 
# File 'lib/weft/generated/models/search_endpoint_price.rb', line 89

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

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
 
# File 'lib/weft/generated/models/search_endpoint_price.rb', line 78

def self.openapi_types
  {
    :'indexed_usd' => :'String',
    :'atomic' => :'Integer',
    :'source' => :'String',
    :'last_observed_at' => :'Time',
    :'live_verified' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



160
161
162
163
164
165
166
167
168
 
# File 'lib/weft/generated/models/search_endpoint_price.rb', line 160

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      indexed_usd == o.indexed_usd &&
      atomic == o.atomic &&
      source == o.source &&
      last_observed_at == o.last_observed_at &&
      live_verified == o.live_verified
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


172
173
174
 
# File 'lib/weft/generated/models/search_endpoint_price.rb', line 172

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



178
179
180
 
# File 'lib/weft/generated/models/search_endpoint_price.rb', line 178

def hash
  [indexed_usd, atomic, source, last_observed_at, live_verified].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



133
134
135
136
137
 
# File 'lib/weft/generated/models/search_endpoint_price.rb', line 133

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/weft/generated/models/search_endpoint_price.rb', line 207

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



141
142
143
144
145
146
 
# File 'lib/weft/generated/models/search_endpoint_price.rb', line 141

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  source_validator = EnumAttributeValidator.new('String', ["probe", "inferred"])
  return false unless source_validator.valid?(@source)
  true
end