Class: CircuitApi::Resources::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/circuit_api/resources/base.rb

Direct Known Subclasses

Conversation, Label, Message, Presence, RtcSession, User, Webhook

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Base

Returns a new instance of Base.



6
7
8
# File 'lib/circuit_api/resources/base.rb', line 6

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientObject (readonly)

Returns the value of attribute client.



4
5
6
# File 'lib/circuit_api/resources/base.rb', line 4

def client
  @client
end

Instance Method Details

#all(params = {}) ⇒ Object



19
20
21
22
# File 'lib/circuit_api/resources/base.rb', line 19

def all(params = {})
  result = connection(api_resource, params).get
  response_to_object(result)
end

#api_resourceObject

Raises:

  • (NotImplementedError)


10
11
12
# File 'lib/circuit_api/resources/base.rb', line 10

def api_resource
  raise NotImplementedError
end

#create(params) ⇒ Object



24
25
26
27
# File 'lib/circuit_api/resources/base.rb', line 24

def create(params)
  result = connection(api_resource, params).post
  response_to_object(result)
end

#delete(id, params = {}) ⇒ Object



34
35
36
37
# File 'lib/circuit_api/resources/base.rb', line 34

def delete(id, params = {})
  result = connection("#{api_resource}/#{id}", params).delete
  response_to_object(result)
end

#delete_all(params = {}) ⇒ Object



39
40
41
42
# File 'lib/circuit_api/resources/base.rb', line 39

def delete_all(params = {})
  result = connection(api_resource, params).delete
  response_to_object(result)
end

#find(id) ⇒ Object



14
15
16
17
# File 'lib/circuit_api/resources/base.rb', line 14

def find(id)
  result = connection("#{api_resource}/#{id}").get
  response_to_object(result)
end

#update(id, params) ⇒ Object



29
30
31
32
# File 'lib/circuit_api/resources/base.rb', line 29

def update(id, params)
  result = connection("#{api_resource}/#{id}", params ).put
  response_to_object(result)
end