Exception: MailchimpAPI::Error

Inherits:

StandardError

• Object
• StandardError
• MailchimpAPI::Error

Defined in:

lib/mailchimp-api/error.rb

Overview

Base error class for all Mailchimp API errors

Direct Known Subclasses

MailchimpAPI::Errors::FailedRequest, MailchimpAPI::Errors::NetworkError

Instance Attribute Summary

• #error_detail ⇒ String^? readonly

  Error description returned by Mailchimp.

• #error_fields ⇒ Hash^? readonly

  Fields specific errors returned by Mailchimp.

• #error_instance ⇒ String^? readonly

  Error ID returned by Mailchimp.

• #error_status ⇒ String readonly

  Error status returned by Mailchimp or response HTTP status.

• #error_title ⇒ String readonly

  Error title returned by Mailchimp or response error class name.

• #error_type ⇒ String^? readonly

  Error type returned by Mailchimp.

• #request ⇒ Request readonly

  Sent request.

• #response ⇒ Response^? readonly

  Returned response with non-200 status code.

Instance Attribute Details

#error_detail ⇒ String^? (readonly)

Returns Error description returned by Mailchimp.

Returns:

• (String, nil) —

  Error description returned by Mailchimp

# File 'lib/mailchimp-api/error.rb', line 22

def error_detail
  @error_detail
end

#error_fields ⇒ Hash^? (readonly)

Returns Fields specific errors returned by Mailchimp.

Returns:

• (Hash, nil) —

  Fields specific errors returned by Mailchimp

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

def error_fields
  @error_fields
end

#error_instance ⇒ String^? (readonly)

Returns Error ID returned by Mailchimp.

Returns:

• (String, nil) —

  Error ID returned by Mailchimp

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

def error_instance
  @error_instance
end

#error_status ⇒ String (readonly)

Returns Error status returned by Mailchimp or response HTTP status.

Returns:

• (String) —

  Error status returned by Mailchimp or response HTTP status

# File 'lib/mailchimp-api/error.rb', line 19

def error_status
  @error_status
end

#error_title ⇒ String (readonly)

Returns Error title returned by Mailchimp or response error class name.

Returns:

• (String) —

  Error title returned by Mailchimp or response error class name

# File 'lib/mailchimp-api/error.rb', line 16

def error_title
  @error_title
end

#error_type ⇒ String^? (readonly)

Returns Error type returned by Mailchimp.

Returns:

• (String, nil) —

  Error type returned by Mailchimp

# File 'lib/mailchimp-api/error.rb', line 13

def error_type
  @error_type
end

#request ⇒ Request (readonly)

Returns Sent request.

Returns:

• (Request) —

  Sent request

# File 'lib/mailchimp-api/error.rb', line 10

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/mailchimp-api/error.rb', line 7

def response
  @response
end