Class: Ribose::Conversation

Inherits:
Base
  • Object
show all
Includes:
Actions::All, Actions::Create, Actions::Delete, Actions::Fetch, Actions::Update
Defined in:
lib/ribose/conversation.rb

Class Method Summary collapse

Methods included from Actions::Delete

#delete

Methods included from Actions::Base

#included

Methods included from Actions::Update

#update

Methods included from Actions::Create

#create

Methods included from Actions::Fetch

#fetch

Methods included from Actions::All

#all

Methods inherited from Base

#initialize

Methods included from ResourceHelper

#resource_key, #resource_path, #resources

Constructor Details

This class inherits a constructor from Ribose::Base

Class Method Details

.all(space_id, options = {}) ⇒ Array <Sawyer::Resource>

Listing Space Conversations

Parameters:

  • space_id (String) —

    The Space UUID

  • options (Hash) (defaults to: {}) —

    Query parameters as a Hash

Returns:

  • (Array <Sawyer::Resource>) 


15
16
17
 
# File 'lib/ribose/conversation.rb', line 15

def self.all(space_id, options = {})
  new(space_id: space_id, **options).all
end

.create(space_id, attributes) ⇒ Sawyer::Resource

Create A New Conversation

Parameters:

  • space_id (String) —

    The Space UUID

  • attributes (Hash) —

    The conversation attributes

Returns:

  • (Sawyer::Resource) 


36
37
38
 
# File 'lib/ribose/conversation.rb', line 36

def self.create(space_id, attributes)
  new(attributes.merge(space_id: space_id)).create
end

.destroy(space_id:, conversation_id:, **opts) ⇒ Object

Remove a conversation

Parameters:

  • space_id (String) —

    The Space UUID

  • conversation_id (String) —

    Conversation UUID

  • options (Hash) —

    Query parameters as a Hash



61
62
63
 
# File 'lib/ribose/conversation.rb', line 61

def self.destroy(space_id:, conversation_id:, **opts)
  new(space_id: space_id, conversation_id: conversation_id, **opts).delete
end

.fetch(space_id, conversation_id, options = {}) ⇒ Sawyer::Resource

Fetch a conversation

Parameters:

  • space_id (String) —

    The Space UUID

  • conversation_id (String) —

    Conversation UUID

  • options (Hash) (defaults to: {}) —

    Query parameters as a Hash

Returns:

  • (Sawyer::Resource) —

    The conversation



26
27
28
 
# File 'lib/ribose/conversation.rb', line 26

def self.fetch(space_id, conversation_id, options = {})
  new(space_id: space_id, conversation_id: conversation_id, **options).fetch
end

.update(space_id, conversation_id, attributes = {}) ⇒ Sawyer::Resource

Update a conversation

Parameters:

  • space_id (String) —

    The Space UUID

  • conversation_id (String) —

    Conversation UUID

  • attributes (Hash) (defaults to: {}) —

    Query parameters as a Hash

Returns:

  • (Sawyer::Resource) —

    The updated conversation



47
48
49
50
51
52
53
 
# File 'lib/ribose/conversation.rb', line 47

def self.update(space_id, conversation_id, attributes = {})
  new(
    space_id: space_id,
    conversation_id: conversation_id,
    **attributes,
  ).update
end