Class: Io::Flow::V0::Models::AuthorizationStatus

Inherits:

Object

• Object
• Io::Flow::V0::Models::AuthorizationStatus

Defined in:

lib/flow_commerce/flow_api_v0_client.rb

Instance Attribute Summary

• #value ⇒ Object readonly

  Returns the value of attribute value.

Class Method Summary

• .ALL ⇒ Object
• .apply(value) ⇒ Object

  Returns the instance of AuthorizationStatus for this value, creating a new instance for an unknown value.

• .authorized ⇒ Object

  Authorization was successful.

• .declined ⇒ Object

  Indicates the authorization has been declined by the issuing bank.

• .expired ⇒ Object

  Authorization has expired.

• .from_string(value) ⇒ Object

  Returns the instance of AuthorizationStatus for this value, or nil if not found.

• .pending ⇒ Object

  If an immediate response is not available, the state will be ‘pending’.

• .reversed ⇒ Object

  Indicates the authorization has been fully reversed.

• .review ⇒ Object

  If an immediate response is not available, the state will be ‘review’ - this usually indicates fraud review requires additional time / verification (or a potential network issue with the issuing bank).

Instance Method Summary

• #initialize(value) ⇒ AuthorizationStatus constructor

  A new instance of AuthorizationStatus.

• #to_hash ⇒ Object

Constructor Details

#initialize(value) ⇒ AuthorizationStatus

Returns a new instance of AuthorizationStatus.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10195

def initialize(value)
  @value = HttpClient::Preconditions.assert_class('value', value, String)
end

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10193

def value
  @value
end

Class Method Details

.ALL ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10215

def AuthorizationStatus.ALL
  @@all ||= [AuthorizationStatus.pending, AuthorizationStatus.expired, AuthorizationStatus.authorized, AuthorizationStatus.review, AuthorizationStatus.declined, AuthorizationStatus.reversed]
end

.apply(value) ⇒ Object

Returns the instance of AuthorizationStatus for this value, creating a new instance for an unknown value

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10200

def AuthorizationStatus.apply(value)
  if value.instance_of?(AuthorizationStatus)
    value
  else
    HttpClient::Preconditions.assert_class_or_nil('value', value, String)
    value.nil? ? nil : (from_string(value) || AuthorizationStatus.new(value))
  end
end

.authorized ⇒ Object

Authorization was successful

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10233

def AuthorizationStatus.authorized
  @@_authorized ||= AuthorizationStatus.new('authorized')
end

.declined ⇒ Object

Indicates the authorization has been declined by the issuing bank. See the authorization decline code for more details as to the reason for decline.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10246

def AuthorizationStatus.declined
  @@_declined ||= AuthorizationStatus.new('declined')
end

.expired ⇒ Object

Authorization has expired.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10228

def AuthorizationStatus.expired
  @@_expired ||= AuthorizationStatus.new('expired')
end

.from_string(value) ⇒ Object

Returns the instance of AuthorizationStatus for this value, or nil if not found

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10210

def AuthorizationStatus.from_string(value)
  HttpClient::Preconditions.assert_class('value', value, String)
  AuthorizationStatus.ALL.find { |v| v.value == value }
end

.pending ⇒ Object

If an immediate response is not available, the state will be ‘pending’. For example, online payment methods like AliPay or PayPal will have a status of ‘pending’ until the user completes the payment. Pending authorizations expire if the user does not complete the payment in a timely fashion.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10223

def AuthorizationStatus.pending
  @@_pending ||= AuthorizationStatus.new('pending')
end

.reversed ⇒ Object

Indicates the authorization has been fully reversed. You can fully reverse an authorization up until the moment you capture funds; once you have captured funds you must create refunds.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10253

def AuthorizationStatus.reversed
  @@_reversed ||= AuthorizationStatus.new('reversed')
end

.review ⇒ Object

If an immediate response is not available, the state will be ‘review’ - this usually indicates fraud review requires additional time / verification (or a potential network issue with the issuing bank)

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10240

def AuthorizationStatus.review
  @@_review ||= AuthorizationStatus.new('review')
end

Instance Method Details

#to_hash ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10257

def to_hash
  value
end