Class: Weft::FetchResponse

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

Overview

Successful fetch envelope. body_base64 is the upstream artifact bytes, base64-encoded. paid_usd, held_usd, payment_status, tx_hash, protocol, and merchant describe the payment and settlement state. paid_usd is "0.00" (never the nominal charge amount) until the charge is CONFIRMED settled on-chain — a signed-but-unsettled hold reports its amount in held_usd instead. This is a deliberate honesty fix: earlier versions of this endpoint returned the nominal amount in paid_usd unconditionally, even when the charge never settled. Money string format. Every USD amount on this surface is exact to the micro-dollar and never narrower than two decimals: a whole-cent amount renders "0.50", a sub-cent amount keeps its real precision ("0.000892"), and zero renders "0.00". Amounts are never rounded — an agent reconciling its own spend reads the truth, not a display value. Parse these as decimals; do NOT compare them as strings against a bare zero literal.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/weft/generated/models/fetch_response.rb', line 121

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

  if attributes.key?(:'headers')
    if (value = attributes[:'headers']).is_a?(Hash)
      self.headers = value
    end
  else
    self.headers = nil
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#artifact_id ⇒ Object

Internal artifact identifier if the response was persisted; null otherwise.



44
45
46
 
# File 'lib/weft/generated/models/fetch_response.rb', line 44

def artifact_id
  @artifact_id
end

#body_base64 ⇒ Object

Base64-encoded response body. Empty string for empty bodies.



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

def body_base64
  @body_base64
end

#headers ⇒ Object

Response headers from the upstream.



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

def headers
  @headers
end

#held_usd ⇒ Object

The nominal charge amount when paid_usd is "0.00" — a hold awaiting settlement, or a charge that failed/expired without ever settling. null once paid_usd reflects the real settlement. Same format as paid_usd: exact to the micro-dollar, minimum two decimals.



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

def held_usd
  @held_usd
end

#merchant ⇒ Object

Merchant reputation snapshot.



47
48
49
 
# File 'lib/weft/generated/models/fetch_response.rb', line 47

def merchant
  @merchant
end

USD amount actually settled on-chain. "0.00" for any charge that hasn't (yet, or ever) settled — a signed hold is not yet spend. See held_usd for the nominal amount in that case. Exact to the micro-dollar, minimum two decimals; parse as a decimal rather than string-comparing against a bare zero literal.



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

def paid_usd
  @paid_usd
end

#payment_status ⇒ Object

Agent-facing settlement status. pending = signed, no refusal signal yet (settlement may still land, e.g. x402's async facilitator webhook). declined-pending = the merchant refused but the authorization isn't provably dead yet. declined / expired / reverted are terminal — the money never moved (or, for reverted, moved and then reversed on-chain) and never will for this charge.



35
36
37
 
# File 'lib/weft/generated/models/fetch_response.rb', line 35

def payment_status
  @payment_status
end

#protocol ⇒ Object

Payment protocol selected for this fetch.



41
42
43
 
# File 'lib/weft/generated/models/fetch_response.rb', line 41

def protocol
  @protocol
end

#status ⇒ Object

HTTP status returned by the upstream after the paid replay.



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

def status
  @status
end

#tx_hash ⇒ Object

Settlement transaction hash. Null until a settlement hash has been reported.



38
39
40
 
# File 'lib/weft/generated/models/fetch_response.rb', line 38

def tx_hash
  @tx_hash
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



88
89
90
 
# File 'lib/weft/generated/models/fetch_response.rb', line 88

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



93
94
95
 
# File 'lib/weft/generated/models/fetch_response.rb', line 93

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/weft/generated/models/fetch_response.rb', line 72

def self.attribute_map
  {
    :'status' => :'status',
    :'headers' => :'headers',
    :'body_base64' => :'body_base64',
    :'paid_usd' => :'paid_usd',
    :'held_usd' => :'held_usd',
    :'payment_status' => :'payment_status',
    :'tx_hash' => :'tx_hash',
    :'protocol' => :'protocol',
    :'artifact_id' => :'artifact_id',
    :'merchant' => :'merchant'
  }
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



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/weft/generated/models/fetch_response.rb', line 399

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



114
115
116
117
 
# File 'lib/weft/generated/models/fetch_response.rb', line 114

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

.openapi_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/weft/generated/models/fetch_response.rb', line 98

def self.openapi_types
  {
    :'status' => :'Integer',
    :'headers' => :'Hash<String, String>',
    :'body_base64' => :'String',
    :'paid_usd' => :'String',
    :'held_usd' => :'String',
    :'payment_status' => :'String',
    :'tx_hash' => :'String',
    :'protocol' => :'String',
    :'artifact_id' => :'Integer',
    :'merchant' => :'Merchant'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/weft/generated/models/fetch_response.rb', line 369

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      status == o.status &&
      headers == o.headers &&
      body_base64 == o.body_base64 &&
      paid_usd == o.paid_usd &&
      held_usd == o.held_usd &&
      payment_status == o.payment_status &&
      tx_hash == o.tx_hash &&
      protocol == o.protocol &&
      artifact_id == o.artifact_id &&
      merchant == o.merchant
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


386
387
388
 
# File 'lib/weft/generated/models/fetch_response.rb', line 386

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



392
393
394
 
# File 'lib/weft/generated/models/fetch_response.rb', line 392

def hash
  [status, headers, body_base64, paid_usd, held_usd, payment_status, tx_hash, protocol, artifact_id, merchant].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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/weft/generated/models/fetch_response.rb', line 200

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

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

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

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

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

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

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

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

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

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



421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/weft/generated/models/fetch_response.rb', line 421

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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/weft/generated/models/fetch_response.rb', line 248

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @status.nil?
  return false if @headers.nil?
  return false if @body_base64.nil?
  return false if @paid_usd.nil?
  return false if @held_usd.nil?
  return false if @payment_status.nil?
  payment_status_validator = EnumAttributeValidator.new('String', ["settled", "pending", "declined-pending", "declined", "expired", "reverted"])
  return false unless payment_status_validator.valid?(@payment_status)
  return false if @tx_hash.nil?
  return false if @protocol.nil?
  protocol_validator = EnumAttributeValidator.new('String', ["x402", "mpp"])
  return false unless protocol_validator.valid?(@protocol)
  return false if @artifact_id.nil?
  return false if @merchant.nil?
  true
end