Class: Weft::FetchErrorResponse

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

Overview

Bespoke error envelope for ‘/api/v1/fetch`. Every error carries the buyer’s current ‘policy`, `balance`, and a `dashboard_url` so a CLI can render an actionable message without a second round-trip. `error` values include the fixed codes listed below plus the family `POLICY_VIOLATION_<REASON>` (e.g. `POLICY_VIOLATION_DAILY_LIMIT`) where `<REASON>` matches the violated policy field.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



94
95
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
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/weft/generated/models/fetch_error_response.rb', line 94

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

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

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

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

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

Instance Attribute Details

#balance ⇒ Object

Returns the value of attribute balance.



27
28
29
 
# File 'lib/weft/generated/models/fetch_error_response.rb', line 27

def balance
  @balance
end

#dashboard_url ⇒ Object

Deep-link to the dashboard’s policy page.



30
31
32
 
# File 'lib/weft/generated/models/fetch_error_response.rb', line 30

def dashboard_url
  @dashboard_url
end

#details ⇒ Object

Optional context. Shape varies by error code.



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

def details
  @details
end

#error ⇒ Object

Stable error code.



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

def error
  @error
end

#policy ⇒ Object

Returns the value of attribute policy.



25
26
27
 
# File 'lib/weft/generated/models/fetch_error_response.rb', line 25

def policy
  @policy
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



66
67
68
 
# File 'lib/weft/generated/models/fetch_error_response.rb', line 66

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



71
72
73
 
# File 'lib/weft/generated/models/fetch_error_response.rb', line 71

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
 
# File 'lib/weft/generated/models/fetch_error_response.rb', line 55

def self.attribute_map
  {
    :'error' => :'error',
    :'details' => :'details',
    :'policy' => :'policy',
    :'balance' => :'balance',
    :'dashboard_url' => :'dashboard_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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/weft/generated/models/fetch_error_response.rb', line 260

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
 
# File 'lib/weft/generated/models/fetch_error_response.rb', line 76

def self.openapi_types
  {
    :'error' => :'String',
    :'details' => :'Hash<String, Object>',
    :'policy' => :'SpendingPolicy',
    :'balance' => :'FetchBalanceSnapshot',
    :'dashboard_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



235
236
237
238
239
240
241
242
243
 
# File 'lib/weft/generated/models/fetch_error_response.rb', line 235

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      error == o.error &&
      details == o.details &&
      policy == o.policy &&
      balance == o.balance &&
      dashboard_url == o.dashboard_url
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


247
248
249
 
# File 'lib/weft/generated/models/fetch_error_response.rb', line 247

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



253
254
255
 
# File 'lib/weft/generated/models/fetch_error_response.rb', line 253

def hash
  [error, details, policy, balance, dashboard_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



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

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

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

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

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

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



282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/weft/generated/models/fetch_error_response.rb', line 282

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



171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/weft/generated/models/fetch_error_response.rb', line 171

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @error.nil?
  error_validator = EnumAttributeValidator.new('String', ["INVALID_URL", "EXCEEDED_MAX_COST", "INSUFFICIENT_BALANCE", "MERCHANT_RETURNED_NON_402", "ARTIFACT_TOO_LARGE", "DENYLISTED_RECIPIENT", "SETTLEMENT_FAILED", "POLICY_VIOLATION"])
  return false unless error_validator.valid?(@error)
  return false if @details.nil?
  return false if @policy.nil?
  return false if @balance.nil?
  return false if @dashboard_url.nil?
  true
end