Exception: PaypalAPI::Error

Inherits:

StandardError

• Object
• StandardError
• PaypalAPI::Error

Defined in:

lib/paypal-api/error.rb

Overview

Common interface for all errors

Direct Known Subclasses

PaypalAPI::Errors::FailedRequest, PaypalAPI::Errors::NetworkError

Instance Attribute Summary

• #error_debug_id ⇒ String^? readonly

  Error debug_id returned by PayPal.

• #error_details ⇒ Array^? readonly

  Error details returned by PayPal.

• #error_message ⇒ String readonly

  Error message provided by PayPal or Net::HTTP network error message.

• #error_name ⇒ String readonly

  Error name provided by PayPal or Net::HTTP network error name.

• #paypal_request_id ⇒ String^? readonly

  PayPal-Request-Id header assigned to request.

• #request ⇒ Request readonly

  Sent request.

• #response ⇒ Response^? readonly

  Returned response with non-200 status code.

Instance Attribute Details

#error_debug_id ⇒ String^? (readonly)

Returns Error debug_id returned by PayPal.

Returns:

• (String, nil) —

  Error debug_id returned by PayPal

# File 'lib/paypal-api/error.rb', line 21

def error_debug_id
  @error_debug_id
end

#error_details ⇒ Array^? (readonly)

Returns Error details returned by PayPal.

Returns:

• (Array, nil) —

  Error details returned by PayPal

See Also:

• https://developer.paypal.com/api/rest/responses/#link-examples

# File 'lib/paypal-api/error.rb', line 25

def error_details
  @error_details
end

#error_message ⇒ String (readonly)

Returns Error message provided by PayPal or Net::HTTP network error message.

Returns:

• (String) —

  Error message provided by PayPal or Net::HTTP network error message

# File 'lib/paypal-api/error.rb', line 18

def error_message
  @error_message
end

#error_name ⇒ String (readonly)

Returns Error name provided by PayPal or Net::HTTP network error name.

Returns:

• (String) —

  Error name provided by PayPal or Net::HTTP network error name

# File 'lib/paypal-api/error.rb', line 15

def error_name
  @error_name
end

#paypal_request_id ⇒ String^? (readonly)

Returns PayPal-Request-Id header assigned to request.

Returns:

• (String, nil) —

  PayPal-Request-Id header assigned to request

# File 'lib/paypal-api/error.rb', line 28

def paypal_request_id
  @paypal_request_id
end

#request ⇒ Request (readonly)

Returns Sent request.

Returns:

• (Request) —

  Sent request

# File 'lib/paypal-api/error.rb', line 12

def request
  @request
end

#response ⇒ Response^? (readonly)

Returned response with non-200 status code

Returns:

• (Response, nil) —

  Returned response with non-200 status code

# File 'lib/paypal-api/error.rb', line 9

def response
  @response
end