Class: Rapidmail::Resources::Base

Inherits:

Object

• Object
• Rapidmail::Resources::Base

Extended by:

Forwardable

Defined in:

lib/rapidmail/resources/base.rb

Overview

Base class for all resource classes.

Direct Known Subclasses

Job, Mailing, Recipient, RecipientList

Instance Attribute Summary

• #client ⇒ Object readonly

  Returns the value of attribute client.

Instance Method Summary

• #find(id) ⇒ Faraday::Response

  Finds a resource by ID.

• #initialize(client) ⇒ Base constructor

  Initializes a new resource instance.

Constructor Details

#initialize(client) ⇒ Base

Initializes a new resource instance.

Parameters:

• client (Rapidmail::Client) —

  The client instance.

# File 'lib/rapidmail/resources/base.rb', line 16

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.

# File 'lib/rapidmail/resources/base.rb', line 9

def client
  @client
end

Instance Method Details

#find(id) ⇒ Faraday::Response

Finds a resource by ID.

Parameters:

• id (String) —

  The ID of the resource.

Returns:

• (Faraday::Response) —

  The response from the API.

# File 'lib/rapidmail/resources/base.rb', line 24

def find(id)
  get("#{resource_path}/#{id}")
end