feat: added support for archiving / unarchiving channels

Author: totalimmersion

channel.go

@@ -898,3 +898,39 @@ func (ch *Channel) Unpin(ctx context.Context, userID string) (*ChannelMemberResp
 	err := ch.client.makeRequest(ctx, http.MethodPatch, p, nil, data, resp)
 	return resp, err
 }
+
+func (ch *Channel) Archive(ctx context.Context, userID string) (*ChannelMemberResponse, error) {
+	if userID == "" {
+		return nil, errors.New("user ID must be not empty")
+	}
+
+	p := path.Join("channels", url.PathEscape(ch.Type), url.PathEscape(ch.ID), "member", url.PathEscape(userID))
+
+	data := map[string]interface{}{
+		"set": map[string]interface{}{
+			"archived": true,
+		},
+	}
+
+	resp := &ChannelMemberResponse{}
+	err := ch.client.makeRequest(ctx, http.MethodPatch, p, nil, data, resp)
+	return resp, err
+}
+
+func (ch *Channel) Unarchive(ctx context.Context, userID string) (*ChannelMemberResponse, error) {
+	if userID == "" {
+		return nil, errors.New("user ID must be not empty")
+	}
+
+	p := path.Join("channels", url.PathEscape(ch.Type), url.PathEscape(ch.ID), "member", url.PathEscape(userID))
+
+	data := map[string]interface{}{
+		"set": map[string]interface{}{
+			"archived": false,
+		},
+	}
+
+	resp := &ChannelMemberResponse{}
+	err := ch.client.makeRequest(ctx, http.MethodPatch, p, nil, data, resp)
+	return resp, err
+}

channel_test.go

@@ -679,6 +679,75 @@ func TestChannel_Pin(t *testing.T) {
 	require.NoError(t, err, "query pinned channel")
 	require.Len(t, channels, 1)
 	require.Equal(t, channels[0].CID, ch.CID)
+
+	member, err = ch.Unpin(ctx, users[0].ID)
+	require.NoError(t, err, "unpin channel")
+	require.Nil(t, member.ChannelMember.PinnedAt)
+
+	// query for pinned the channel
+	queryChannResp, err = c.QueryChannels(ctx, &QueryOption{
+		UserID: users[0].ID,
+		Filter: map[string]interface{}{
+			"pinned": false,
+			"cid":    ch.CID,
+		},
+	})
+
+	channels = queryChannResp.Channels
+	require.NoError(t, err, "query pinned channel")
+	require.Len(t, channels, 1)
+	require.Equal(t, channels[0].CID, ch.CID)
+}
+
+func TestChannel_Archive(t *testing.T) {
+	c := initClient(t)
+	ctx := context.Background()
+	users := randomUsers(t, c, 5)
+
+	members := make([]string, 0, len(users))
+	for i := range users {
+		members = append(members, users[i].ID)
+	}
+	ch := initChannel(t, c, members...)
+
+	//pin the channel
+	now := time.Now()
+	member, err := ch.Archive(ctx, users[0].ID)
+	require.NoError(t, err, "archive channel")
+	require.NotNil(t, member.ChannelMember.ArchivedAt)
+	require.GreaterOrEqual(t, member.ChannelMember.ArchivedAt.Unix(), now.Unix())
+
+	// query for pinned the channel
+	queryChannResp, err := c.QueryChannels(ctx, &QueryOption{
+		UserID: users[0].ID,
+		Filter: map[string]interface{}{
+			"archived": true,
+			"cid":      ch.CID,
+		},
+	})
+
+	channels := queryChannResp.Channels
+	require.NoError(t, err, "query archived channel")
+	require.Len(t, channels, 1)
+	require.Equal(t, channels[0].CID, ch.CID)
+
+	member, err = ch.Unarchive(ctx, users[0].ID)
+	require.NoError(t, err, "unarchive channel")
+	require.Nil(t, member.ChannelMember.ArchivedAt)
+
+	// query for pinned the channel
+	queryChannResp, err = c.QueryChannels(ctx, &QueryOption{
+		UserID: users[0].ID,
+		Filter: map[string]interface{}{
+			"archived": false,
+			"cid":      ch.CID,
+		},
+	})
+
+	channels = queryChannResp.Channels
+	require.NoError(t, err, "query archived channel")
+	require.Len(t, channels, 1)
+	require.Equal(t, channels[0].CID, ch.CID)
 }
 
 func ExampleChannel_Update() {