Exception: Sendly::Error

Inherits:

StandardError

• Object
• StandardError
• Sendly::Error

Defined in:

lib/sendly/errors.rb

Overview

Base error class for all Sendly errors

Direct Known Subclasses

APIError, AuthenticationError, InsufficientCreditsError, NetworkError, NotFoundError, RateLimitError, ServerError, ValidationError, WebhookSignatureError

Instance Attribute Summary

• #code ⇒ String^? readonly

  Error code from the API.

• #details ⇒ Hash^? readonly

  Additional error details.

• #status_code ⇒ Integer^? readonly

  HTTP status code.

Instance Method Summary

• #initialize(message = nil, code: nil, details: nil, status_code: nil) ⇒ Error constructor

  A new instance of Error.

Constructor Details

#initialize(message = nil, code: nil, details: nil, status_code: nil) ⇒ Error

Returns a new instance of Error.

# File 'lib/sendly/errors.rb', line 15

def initialize(message = nil, code: nil, details: nil, status_code: nil)
  @code = code
  @details = details
  @status_code = status_code
  super(message)
end

Instance Attribute Details

#code ⇒ String^? (readonly)

Returns Error code from the API.

Returns:

• (String, nil) —

  Error code from the API

# File 'lib/sendly/errors.rb', line 7

def code
  @code
end

#details ⇒ Hash^? (readonly)

Returns Additional error details.

Returns:

• (Hash, nil) —

  Additional error details

# File 'lib/sendly/errors.rb', line 10

def details
  @details
end

#status_code ⇒ Integer^? (readonly)

Returns HTTP status code.

Returns:

• (Integer, nil) —

  HTTP status code

# File 'lib/sendly/errors.rb', line 13

def status_code
  @status_code
end