Module: MixinBot::API::Conversation

Included in:
MixinBot::API
Defined in:
lib/mixin_bot/api/conversation.rb

Instance Method Summary collapse

Instance Method Details

#add_conversation_participants(conversation_id:, user_ids:, access_token: nil) ⇒ Object

participants = [{ user_id: “” }]



77
78
79
80
81
82
# File 'lib/mixin_bot/api/conversation.rb', line 77

def add_conversation_participants(conversation_id:, user_ids:, access_token: nil)
  path = format('/conversations/%<id>s/participants/ADD', id: conversation_id)
  payload = user_ids.map(&->(participant) { { user_id: participant } })

  client.post path, *payload, access_token:
end

#conversation(conversation_id, access_token: nil) ⇒ Object



6
7
8
9
# File 'lib/mixin_bot/api/conversation.rb', line 6

def conversation(conversation_id, access_token: nil)
  path = format('/conversations/%<conversation_id>s', conversation_id:)
  client.get path, access_token:
end

#conversation_by_user_id(user_id) ⇒ Object



11
12
13
14
# File 'lib/mixin_bot/api/conversation.rb', line 11

def conversation_by_user_id(user_id)
  conversation_id = unique_uuid user_id
  conversation conversation_id
end

#create_contact_conversation(user_id, access_token: nil) ⇒ Object



45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/mixin_bot/api/conversation.rb', line 45

def create_contact_conversation(user_id, access_token: nil)
  create_conversation(
    category: 'CONTACT',
    conversation_id: unique_uuid(user_id),
    participants: [
      {
        user_id:
      }
    ],
    access_token:
  )
end

#create_conversation(**kwargs) ⇒ Object



16
17
18
19
20
21
22
23
24
25
26
27
28
# File 'lib/mixin_bot/api/conversation.rb', line 16

def create_conversation(**kwargs)
  path = '/conversations'
  payload = {
    announcement: kwargs[:announcement],
    category: kwargs[:category],
    conversation_id: kwargs[:conversation_id],
    name: kwargs[:name],
    participants: kwargs[:participants],
    random_id: kwargs[:random_id]
  }.compact_blank

  client.post path, **payload, access_token: kwargs[:access_token]
end

#create_group_conversation(user_ids:, name:, **kwargs) ⇒ Object



30
31
32
33
34
35
36
37
38
39
40
41
42
43
# File 'lib/mixin_bot/api/conversation.rb', line 30

def create_group_conversation(user_ids:, name:, **kwargs)
  random_id = kwargs[:random_id] || SecureRandom.uuid
  conversation_id = kwargs[:conversation_id] || MixinBot.utils.generate_group_conversation_id(user_ids:, name:,
                                                                                              owner_id: config.app_id, random_id:)
  create_conversation(
    announcement: kwargs[:announcement],
    category: 'GROUP',
    conversation_id:,
    name:,
    participants: user_ids.map(&->(participant) { { user_id: participant } }),
    random_id:,
    access_token: kwargs[:access_token]
  )
end

#exit_conversation(conversation_id, access_token: nil) ⇒ Object



92
93
94
95
96
# File 'lib/mixin_bot/api/conversation.rb', line 92

def exit_conversation(conversation_id, access_token: nil)
  path = format('/conversations/%<id>s/exit', id: conversation_id)

  client.post path, access_token:
end

#join_conversation(conversation_id, access_token: nil) ⇒ Object



98
99
100
101
# File 'lib/mixin_bot/api/conversation.rb', line 98

def join_conversation(conversation_id, access_token: nil)
  path = format('/conversations/%<conversation_id>s/join', conversation_id:)
  client.post path, access_token:
end

#remove_conversation_participants(conversation_id:, user_ids:, access_token: nil) ⇒ Object

participants = [{ user_id: “” }]



85
86
87
88
89
90
# File 'lib/mixin_bot/api/conversation.rb', line 85

def remove_conversation_participants(conversation_id:, user_ids:, access_token: nil)
  path = format('/conversations/%<id>s/participants/REMOVE', id: conversation_id)
  payload = user_ids.map(&->(participant) { { user_id: participant } })

  client.post path, *payload, access_token:
end

#rotate_conversation(conversation_id, access_token: nil) ⇒ Object



103
104
105
106
107
# File 'lib/mixin_bot/api/conversation.rb', line 103

def rotate_conversation(conversation_id, access_token: nil)
  path = format('/conversations/%<id>s/rotate', id: conversation_id)

  client.post path, access_token:
end

#unique_uuid(user_id, opponent_id = nil) ⇒ Object Also known as: unique_conversation_id



117
118
119
120
# File 'lib/mixin_bot/api/conversation.rb', line 117

def unique_uuid(user_id, opponent_id = nil)
  opponent_id ||= config.app_id
  MixinBot.utils.unique_uuid user_id, opponent_id
end

#update_conversation_participants_role(conversation_id:, participants:, access_token: nil) ⇒ Object

participants = [{ user_id: “”, role: “ADMIN” }]



110
111
112
113
114
115
# File 'lib/mixin_bot/api/conversation.rb', line 110

def update_conversation_participants_role(conversation_id:, participants:, access_token: nil)
  path = format('/conversations/%<id>s/participants/ROLE', id: conversation_id)
  payload = participants

  client.post path, *payload, access_token:
end

#update_group_conversation_announcement(announcement:, conversation_id:, access_token: nil) ⇒ Object



67
68
69
70
71
72
73
74
# File 'lib/mixin_bot/api/conversation.rb', line 67

def update_group_conversation_announcement(announcement:, conversation_id:, access_token: nil)
  path = format('/conversations/%<id>s', id: conversation_id)
  payload = {
    announcement:
  }

  client.post path, **payload, access_token:
end

#update_group_conversation_name(name:, conversation_id:, access_token: nil) ⇒ Object



58
59
60
61
62
63
64
65
# File 'lib/mixin_bot/api/conversation.rb', line 58

def update_group_conversation_name(name:, conversation_id:, access_token: nil)
  path = format('/conversations/%<id>s', id: conversation_id)
  payload = {
    name:
  }

  client.post path, **payload, access_token:
end