Class: FaithTeams::API::V2::Resource::Base

Inherits:
GatewayBase
  • Object
show all
Defined in:
lib/faithteams/api/v2/resource/base.rb

Overview

Common Resource functionality Additional methods can be added but the following methods should not be missing

Direct Known Subclasses

Batch, Contribution, ContributionType, Fund, Person

Instance Method Summary collapse

Methods inherited from GatewayBase

#initialize, #valid_connection?

Constructor Details

This class inherits a constructor from FaithTeams::API::V2::GatewayBase

Instance Method Details

#create(entity:) ⇒ Entity::Base, false

Parameters:

Returns:

Raises:

  • (NotImplementedError) 


27
28
29
 
# File 'lib/faithteams/api/v2/resource/base.rb', line 27

def create(entity:)
  raise NotImplementedError
end

#delete(id:) ⇒ Boolean

Parameters:

  • id (#to_s) —

    ID of the entity to delete

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


39
40
41
 
# File 'lib/faithteams/api/v2/resource/base.rb', line 39

def delete(id:)
  raise NotImplementedError
end

#find(id:) ⇒ Entity::Base?

Parameters:

  • id (Integer) —

    The contribution payment_id.

Returns:

Raises:

  • (NotImplementedError) 


15
16
17
 
# File 'lib/faithteams/api/v2/resource/base.rb', line 15

def find(id:)
  raise NotImplementedError
end

#search(**args) ⇒ Array<Entity::Base>

Parameters:

  • args (Hash) —

    Key values to search with

Returns:

Raises:

  • (NotImplementedError) 


21
22
23
 
# File 'lib/faithteams/api/v2/resource/base.rb', line 21

def search(**args)
  raise NotImplementedError
end

#update(entity:) ⇒ Entity::Base, false

Parameters:

Returns:

Raises:

  • (NotImplementedError) 


33
34
35
 
# File 'lib/faithteams/api/v2/resource/base.rb', line 33

def update(entity:)
  raise NotImplementedError
end